hatoba / Client / list_clusters

list_clusters

hatoba.Client.list_clusters(**kwargs)

クラスターの情報一覧を取得します。 1回のリクエストで、複数のクラスター情報を取得できます。

See also: NIFCLOUD API Documentation

Request Syntax

response = client.list_clusters(
    Filters='string'
)

Parameters:

Filters (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Clusters': [
        {
            'AddonsConfig': {
                'HttpLoadBalancing': {
                    'Disabled': True|False
                }
            },
            'CreateTime': 'string',
            'Description': 'string',
            'FirewallGroup': 'string',
            'InitialKubernetesVersion': 'string',
            'InitialNodeCount': 123,
            'KubernetesVersion': 'string',
            'Locations': [
                'string',
            ],
            'Name': 'string',
            'NetworkConfig': {
                'NetworkId': 'string'
            },
            'NodeCount': 123,
            'NodePools': [
                {
                    'InitialNodeCount': 123,
                    'InstanceType': 'string',
                    'Name': 'string',
                    'NodeCount': 123,
                    'Nodes': [
                        {
                            'AvailabilityZone': 'string',
                            'Name': 'string',
                            'PrivateIpAddress': 'string',
                            'PublicIpAddress': 'string',
                            'Status': 'string'
                        },
                    ],
                    'Nrn': 'string',
                    'Status': 'string',
                    'Tags': [
                        {
                            'Id': 'string',
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ]
                },
            ],
            'Nrn': 'string',
            'Status': 'string',
            'Tags': [
                {
                    'Id': 'string',
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
}

Response Structure

• (dict) –

  • Clusters (list) –

    • (dict) –

      • AddonsConfig (dict) –

        • HttpLoadBalancing (dict) –

          • Disabled (boolean) –

      • CreateTime (string) –

      • Description (string) –

      • FirewallGroup (string) –

      • InitialKubernetesVersion (string) –

      • InitialNodeCount (integer) –

      • KubernetesVersion (string) –

      • Locations (list) –

        • (string) –

      • Name (string) –

      • NetworkConfig (dict) –

        • NetworkId (string) –

      • NodeCount (integer) –

      • NodePools (list) –

        • (dict) –

          • InitialNodeCount (integer) –

          • InstanceType (string) –

          • Name (string) –

          • NodeCount (integer) –

          • Nodes (list) –

            • (dict) –

              • AvailabilityZone (string) –

              • Name (string) –

              • PrivateIpAddress (string) –

              • PublicIpAddress (string) –

              • Status (string) –

          • Nrn (string) –

          • Status (string) –

          • Tags (list) –

            • (dict) –

              • Id (string) –

              • Key (string) –

              • Value (string) –

      • Nrn (string) –

      • Status (string) –

      • Tags (list) –

        • (dict) –

          • Id (string) –

          • Key (string) –

          • Value (string) –