hatoba

Table of Contents

• hatoba
  • Client
  • Client Exceptions
  • Waiters

Client

class hatoba.Client

A low-level client representing NIFCLOUD Kubernetes Service Hatoba

client = session.create_client('hatoba')

These are the available methods:

• attach_disk()
• authorize_firewall_group()
• can_paginate()
• create_cluster()
• create_disk()
• create_firewall_group()
• create_node_pool()
• create_snapshot()
• create_tags()
• delete_cluster()
• delete_clusters()
• delete_disk()
• delete_disks()
• delete_firewall_group()
• delete_firewall_groups()
• delete_node_pool()
• delete_node_pools()
• delete_snapshot()
• delete_snapshots()
• delete_tags()
• detach_disk()
• generate_presigned_url()
• get_cluster()
• get_cluster_credentials()
• get_disk()
• get_firewall_group()
• get_load_balancer()
• get_node_pool()
• get_paginator()
• get_server_config()
• get_snapshot()
• get_waiter()
• list_clusters()
• list_disks()
• list_firewall_groups()
• list_load_balancers()
• list_node_pools()
• list_snapshots()
• list_tags()
• reboot_node()
• restore_cluster_from_snapshot()
• revoke_firewall_group()
• set_node_pool_size()
• update_cluster()
• update_disk()
• update_firewall_group()
• update_node_pool()
• update_snapshot()
• update_tags()

attach_disk(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.attach_disk(
    DiskName='string',
    NodeName='string'
)

Parameters:

• DiskName (string) – [REQUIRED]
• NodeName (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'Disk': {
        'Attachments': [
            {
                'AttachTime': 'string',
                'DevicePath': 'string',
                'NodeName': 'string',
                'Status': 'string'
            },
        ],
        'AvailabilityZone': 'string',
        'Cluster': {
            'Name': 'string'
        },
        'CreateTime': 'string',
        'Description': 'string',
        'Name': 'string',
        'Nrn': 'string',
        'Size': 123,
        'Status': 'string',
        'Tags': [
            {
                'Id': 'string',
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'Type': 'string'
    }
}

Response Structure

• (dict) –
  • Disk (dict) –
    • Attachments (list) –
      • (dict) –
        • AttachTime (string) –
        • DevicePath (string) –
        • NodeName (string) –
        • Status (string) –
    • AvailabilityZone (string) –
    • Cluster (dict) –
      • Name (string) –
    • CreateTime (string) –
    • Description (string) –
    • Name (string) –
    • Nrn (string) –
    • Size (integer) –
    • Status (string) –
    • Tags (list) –
      • (dict) –
        • Id (string) –
        • Key (string) –
        • Value (string) –
    • Type (string) –

authorize_firewall_group(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.authorize_firewall_group(
    FirewallGroupName='string',
    Rules=[
        {
            'CidrIp': 'string',
            'Description': 'string',
            'Direction': 'IN'|'OUT',
            'FromPort': 123,
            'Protocol': 'ANY'|'TCP'|'UDP'|'ICMP'|'SSH'|'HTTP'|'HTTPS'|'RDP'|'GRE'|'ESP'|'AH'|'VRRP'|'L2TP',
            'ToPort': 123
        },
    ]
)

Parameters:

• FirewallGroupName (string) – [REQUIRED]
• Rules (list) –

  [REQUIRED]

  • (dict) –
    • CidrIp (string) – [REQUIRED]
    • Description (string) –
    • Direction (string) –
    • FromPort (integer) –
    • Protocol (string) –
    • ToPort (integer) –

Return type:

dict

Returns:

Response Syntax

{
    'FirewallGroup': {
        'Description': 'string',
        'Name': 'string',
        'Nrn': 'string',
        'Rules': [
            {
                'CidrIp': 'string',
                'Description': 'string',
                'Direction': 'string',
                'FromPort': 123,
                'Id': 'string',
                'Protocol': 'string',
                'Status': 'string',
                'ToPort': 123
            },
        ],
        'Tags': [
            {
                'Id': 'string',
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

• (dict) –
  • FirewallGroup (dict) –
    • Description (string) –
    • Name (string) –
    • Nrn (string) –
    • Rules (list) –
      • (dict) –
        • CidrIp (string) –
        • Description (string) –
        • Direction (string) –
        • FromPort (integer) –
        • Id (string) –
        • Protocol (string) –
        • Status (string) –
        • ToPort (integer) –
    • Tags (list) –
      • (dict) –
        • Id (string) –
        • Key (string) –
        • Value (string) –

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters:operation_name (string) – The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you’d normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo"). Returns:True if the operation can be paginated, False otherwise.

create_cluster(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_cluster(
    Cluster={
        'Description': 'string',
        'FirewallGroup': 'string',
        'KubernetesVersion': 'v1.23.3'|'v1.23.9'|'v1.24.3',
        'ListOfRequestLocations': [
            'string',
        ],
        'ListOfRequestNodePools': [
            {
                'InstanceType': 'c-medium'|'e-medium'|'medium'|'c-medium4'|'e-medium4'|'medium4'|'c-medium8'|'e-medium8'|'medium8'|'e-medium16'|'medium16'|'e-medium24'|'medium24'|'c-large'|'e-large'|'large'|'c-large8'|'e-large8'|'large8'|'e-large16'|'large16'|'e-large24'|'large24'|'e-large32'|'large32'|'e-extra-large8'|'extra-large8'|'e-extra-large16'|'extra-large16'|'e-extra-large24'|'extra-large24'|'e-extra-large32'|'extra-large32'|'e-extra-large48'|'extra-large48'|'e-double-large16'|'double-large16'|'e-double-large24'|'double-large24'|'e-double-large32'|'double-large32'|'e-double-large48'|'double-large48'|'e-double-large64'|'double-large64'|'e-double-large96'|'double-large96',
                'ListOfRequestTags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'Name': 'string',
                'NodeCount': 123
            },
        ],
        'ListOfRequestTags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'Name': 'string',
        'RequestAddonsConfig': {
            'RequestHttpLoadBalancing': {
                'Disabled': True|False
            }
        },
        'RequestNetworkConfig': {
            'NetworkId': 'string'
        }
    }
)

Parameters:Cluster (dict) –

[REQUIRED]

• Description (string) –
• FirewallGroup (string) – [REQUIRED]
• KubernetesVersion (string) –
• ListOfRequestLocations (list) – [REQUIRED]
  • (string) –
• ListOfRequestNodePools (list) – [REQUIRED]
  • (dict) –
    • InstanceType (string) – [REQUIRED]
    • ListOfRequestTags (list) –
      • (dict) –
        • Key (string) –
        • Value (string) –
    • Name (string) – [REQUIRED]
    • NodeCount (integer) –
• ListOfRequestTags (list) –
  • (dict) –
    • Key (string) –
    • Value (string) –
• Name (string) – [REQUIRED]
• RequestAddonsConfig (dict) –
  • RequestHttpLoadBalancing (dict) –
    • Disabled (boolean) –
• RequestNetworkConfig (dict) –
  • NetworkId (string) –

Return type:dict Returns:Response Syntax

{
    'Cluster': {
        '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) –
  • Cluster (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) –

create_disk(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_disk(
    Disk={
        'AvailabilityZone': 'string',
        'Description': 'string',
        'ListOfRequestTags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'Name': 'string',
        'Size': 123,
        'Type': 'standard-flash-a'|'standard-flash-b'|'high-speed-flash-a'|'high-speed-flash-b'
    }
)

Parameters:Disk (dict) –

[REQUIRED]

• AvailabilityZone (string) –
• Description (string) –
• ListOfRequestTags (list) –
  • (dict) –
    • Key (string) –
    • Value (string) –
• Name (string) – [REQUIRED]
• Size (integer) – [REQUIRED]
• Type (string) – [REQUIRED]

Return type:dict Returns:Response Syntax

{
    'Disk': {
        'Attachments': [
            {
                'AttachTime': 'string',
                'DevicePath': 'string',
                'NodeName': 'string',
                'Status': 'string'
            },
        ],
        'AvailabilityZone': 'string',
        'Cluster': {
            'Name': 'string'
        },
        'CreateTime': 'string',
        'Description': 'string',
        'Name': 'string',
        'Nrn': 'string',
        'Size': 123,
        'Status': 'string',
        'Tags': [
            {
                'Id': 'string',
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'Type': 'string'
    }
}

Response Structure

• (dict) –
  • Disk (dict) –
    • Attachments (list) –
      • (dict) –
        • AttachTime (string) –
        • DevicePath (string) –
        • NodeName (string) –
        • Status (string) –
    • AvailabilityZone (string) –
    • Cluster (dict) –
      • Name (string) –
    • CreateTime (string) –
    • Description (string) –
    • Name (string) –
    • Nrn (string) –
    • Size (integer) –
    • Status (string) –
    • Tags (list) –
      • (dict) –
        • Id (string) –
        • Key (string) –
        • Value (string) –
    • Type (string) –

create_firewall_group(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_firewall_group(
    FirewallGroup={
        'Description': 'string',
        'ListOfRequestTags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'Name': 'string'
    }
)

Parameters:FirewallGroup (dict) –

[REQUIRED]

• Description (string) –
• ListOfRequestTags (list) –
  • (dict) –
    • Key (string) –
    • Value (string) –
• Name (string) – [REQUIRED]

Return type:dict Returns:Response Syntax

{
    'FirewallGroup': {
        'Description': 'string',
        'Name': 'string',
        'Nrn': 'string',
        'Rules': [
            {
                'CidrIp': 'string',
                'Description': 'string',
                'Direction': 'string',
                'FromPort': 123,
                'Id': 'string',
                'Protocol': 'string',
                'Status': 'string',
                'ToPort': 123
            },
        ],
        'Tags': [
            {
                'Id': 'string',
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

• (dict) –
  • FirewallGroup (dict) –
    • Description (string) –
    • Name (string) –
    • Nrn (string) –
    • Rules (list) –
      • (dict) –
        • CidrIp (string) –
        • Description (string) –
        • Direction (string) –
        • FromPort (integer) –
        • Id (string) –
        • Protocol (string) –
        • Status (string) –
        • ToPort (integer) –
    • Tags (list) –
      • (dict) –
        • Id (string) –
        • Key (string) –
        • Value (string) –

create_node_pool(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_node_pool(
    ClusterName='string',
    NodePool={
        'InstanceType': 'c-medium'|'e-medium'|'medium'|'c-medium4'|'e-medium4'|'medium4'|'c-medium8'|'e-medium8'|'medium8'|'e-medium16'|'medium16'|'e-medium24'|'medium24'|'c-large'|'e-large'|'large'|'c-large8'|'e-large8'|'large8'|'e-large16'|'large16'|'e-large24'|'large24'|'e-large32'|'large32'|'e-extra-large8'|'extra-large8'|'e-extra-large16'|'extra-large16'|'e-extra-large24'|'extra-large24'|'e-extra-large32'|'extra-large32'|'e-extra-large48'|'extra-large48'|'e-double-large16'|'double-large16'|'e-double-large24'|'double-large24'|'e-double-large32'|'double-large32'|'e-double-large48'|'double-large48'|'e-double-large64'|'double-large64'|'e-double-large96'|'double-large96',
        'ListOfRequestTags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'Name': 'string',
        'NodeCount': 123
    }
)

Parameters:

• ClusterName (string) – [REQUIRED]
• NodePool (dict) –

  [REQUIRED]

  • InstanceType (string) – [REQUIRED]
  • ListOfRequestTags (list) –
    • (dict) –
      • Key (string) –
      • Value (string) –
  • Name (string) – [REQUIRED]
  • NodeCount (integer) –

Return type:

dict

Returns:

Response Syntax

{
    'NodePool': {
        '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'
            },
        ]
    }
}

Response Structure

• (dict) –
  • NodePool (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) –

create_snapshot(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_snapshot(
    Snapshot={
        'Description': 'string',
        'ExpirationTime': 'string',
        'ListOfRequestTags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'Name': 'string',
        'RequestCluster': {
            'Name': 'string'
        }
    }
)

Parameters:Snapshot (dict) –

[REQUIRED]

• Description (string) –
• ExpirationTime (string) –
• ListOfRequestTags (list) –
  • (dict) –
    • Key (string) –
    • Value (string) –
• Name (string) – [REQUIRED]
• RequestCluster (dict) – [REQUIRED]
  • Name (string) – [REQUIRED]

Return type:dict Returns:Response Syntax

{
    'Snapshot': {
        'Cluster': {
            'KubernetesVersion': 'string',
            'Name': 'string',
            'NodePools': [
                {
                    'InstanceType': 'string',
                    'Name': 'string',
                    'NodeCount': 123
                },
            ]
        },
        'CreateTime': 'string',
        'Description': 'string',
        'ExpirationTime': 'string',
        'Name': 'string',
        'Nrn': 'string',
        'ResourceVersion': 'string',
        'Status': 'string',
        'Tags': [
            {
                'Id': 'string',
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

• (dict) –
  • Snapshot (dict) –
    • Cluster (dict) –
      • KubernetesVersion (string) –
      • Name (string) –
      • NodePools (list) –
        • (dict) –
          • InstanceType (string) –
          • Name (string) –
          • NodeCount (integer) –
    • CreateTime (string) –
    • Description (string) –
    • ExpirationTime (string) –
    • Name (string) –
    • Nrn (string) –
    • ResourceVersion (string) –
    • Status (string) –
    • Tags (list) –
      • (dict) –
        • Id (string) –
        • Key (string) –
        • Value (string) –

create_tags(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_tags(
    Tags=[
        {
            'Key': 'string',
            'Nrn': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:Tags (list) –

[REQUIRED]

• (dict) –
  • Key (string) – [REQUIRED]
  • Nrn (string) – [REQUIRED]
  • Value (string) – [REQUIRED]

Return type:dict Returns:Response Syntax

{
    'Tags': [
        {
            'Id': 'string',
            'Key': 'string',
            'Nrn': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

• (dict) –
  • Tags (list) –
    • (dict) –
      • Id (string) –
      • Key (string) –
      • Nrn (string) –
      • Value (string) –

delete_cluster(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_cluster(
    ClusterName='string'
)

Parameters:ClusterName (string) – [REQUIRED] Return type:dict Returns:Response Syntax

{
    'Cluster': {
        '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) –
  • Cluster (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) –

delete_clusters(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_clusters(
    Names='string'
)

Parameters:Names (string) – [REQUIRED] 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) –

delete_disk(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_disk(
    DiskName='string'
)

Parameters:DiskName (string) – [REQUIRED] Return type:dict Returns:Response Syntax

{
    'Disk': {
        'Attachments': [
            {
                'AttachTime': 'string',
                'DevicePath': 'string',
                'NodeName': 'string',
                'Status': 'string'
            },
        ],
        'AvailabilityZone': 'string',
        'Cluster': {
            'Name': 'string'
        },
        'CreateTime': 'string',
        'Description': 'string',
        'Name': 'string',
        'Nrn': 'string',
        'Size': 123,
        'Status': 'string',
        'Tags': [
            {
                'Id': 'string',
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'Type': 'string'
    }
}

Response Structure

• (dict) –
  • Disk (dict) –
    • Attachments (list) –
      • (dict) –
        • AttachTime (string) –
        • DevicePath (string) –
        • NodeName (string) –
        • Status (string) –
    • AvailabilityZone (string) –
    • Cluster (dict) –
      • Name (string) –
    • CreateTime (string) –
    • Description (string) –
    • Name (string) –
    • Nrn (string) –
    • Size (integer) –
    • Status (string) –
    • Tags (list) –
      • (dict) –
        • Id (string) –
        • Key (string) –
        • Value (string) –
    • Type (string) –

delete_disks(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_disks(
    Names='string'
)

Parameters:Names (string) – [REQUIRED] Return type:dict Returns:Response Syntax

{
    'Disks': [
        {
            'Attachments': [
                {
                    'AttachTime': 'string',
                    'DevicePath': 'string',
                    'NodeName': 'string',
                    'Status': 'string'
                },
            ],
            'AvailabilityZone': 'string',
            'Cluster': {
                'Name': 'string'
            },
            'CreateTime': 'string',
            'Description': 'string',
            'Name': 'string',
            'Nrn': 'string',
            'Size': 123,
            'Status': 'string',
            'Tags': [
                {
                    'Id': 'string',
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'Type': 'string'
        },
    ]
}

Response Structure

• (dict) –
  • Disks (list) –
    • (dict) –
      • Attachments (list) –
        • (dict) –
          • AttachTime (string) –
          • DevicePath (string) –
          • NodeName (string) –
          • Status (string) –
      • AvailabilityZone (string) –
      • Cluster (dict) –
        • Name (string) –
      • CreateTime (string) –
      • Description (string) –
      • Name (string) –
      • Nrn (string) –
      • Size (integer) –
      • Status (string) –
      • Tags (list) –
        • (dict) –
          • Id (string) –
          • Key (string) –
          • Value (string) –
      • Type (string) –

delete_firewall_group(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_firewall_group(
    FirewallGroupName='string'
)

Parameters:FirewallGroupName (string) – [REQUIRED] Return type:dict Returns:Response Syntax

{
    'FirewallGroup': {
        'Description': 'string',
        'Name': 'string',
        'Nrn': 'string',
        'Rules': [
            {
                'CidrIp': 'string',
                'Description': 'string',
                'Direction': 'string',
                'FromPort': 123,
                'Id': 'string',
                'Protocol': 'string',
                'Status': 'string',
                'ToPort': 123
            },
        ],
        'Tags': [
            {
                'Id': 'string',
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

• (dict) –
  • FirewallGroup (dict) –
    • Description (string) –
    • Name (string) –
    • Nrn (string) –
    • Rules (list) –
      • (dict) –
        • CidrIp (string) –
        • Description (string) –
        • Direction (string) –
        • FromPort (integer) –
        • Id (string) –
        • Protocol (string) –
        • Status (string) –
        • ToPort (integer) –
    • Tags (list) –
      • (dict) –
        • Id (string) –
        • Key (string) –
        • Value (string) –

delete_firewall_groups(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_firewall_groups(
    Names='string'
)

Parameters:Names (string) – Return type:dict Returns:Response Syntax

{
    'FirewallGroups': [
        {
            'Description': 'string',
            'Name': 'string',
            'Nrn': 'string',
            'Rules': [
                {
                    'CidrIp': 'string',
                    'Description': 'string',
                    'Direction': 'string',
                    'FromPort': 123,
                    'Id': 'string',
                    'Protocol': 'string',
                    'Status': 'string',
                    'ToPort': 123
                },
            ],
            'Tags': [
                {
                    'Id': 'string',
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
}

Response Structure

• (dict) –
  • FirewallGroups (list) –
    • (dict) –
      • Description (string) –
      • Name (string) –
      • Nrn (string) –
      • Rules (list) –
        • (dict) –
          • CidrIp (string) –
          • Description (string) –
          • Direction (string) –
          • FromPort (integer) –
          • Id (string) –
          • Protocol (string) –
          • Status (string) –
          • ToPort (integer) –
      • Tags (list) –
        • (dict) –
          • Id (string) –
          • Key (string) –
          • Value (string) –

delete_node_pool(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_node_pool(
    ClusterName='string',
    NodePoolName='string'
)

Parameters:

• ClusterName (string) – [REQUIRED]
• NodePoolName (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'NodePool': {
        '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'
            },
        ]
    }
}

Response Structure

• (dict) –
  • NodePool (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) –

delete_node_pools(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_node_pools(
    ClusterName='string',
    Names='string'
)

Parameters:

• ClusterName (string) – [REQUIRED]
• Names (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    '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'
                },
            ]
        },
    ]
}

Response Structure

• (dict) –
  • 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) –

delete_snapshot(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_snapshot(
    SnapshotName='string'
)

Parameters:SnapshotName (string) – [REQUIRED] Return type:dict Returns:Response Syntax

{
    'Snapshot': {
        'Cluster': {
            'KubernetesVersion': 'string',
            'Name': 'string',
            'NodePools': [
                {
                    'InstanceType': 'string',
                    'Name': 'string',
                    'NodeCount': 123
                },
            ]
        },
        'CreateTime': 'string',
        'Description': 'string',
        'ExpirationTime': 'string',
        'Name': 'string',
        'Nrn': 'string',
        'ResourceVersion': 'string',
        'Status': 'string',
        'Tags': [
            {
                'Id': 'string',
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

• (dict) –
  • Snapshot (dict) –
    • Cluster (dict) –
      • KubernetesVersion (string) –
      • Name (string) –
      • NodePools (list) –
        • (dict) –
          • InstanceType (string) –
          • Name (string) –
          • NodeCount (integer) –
    • CreateTime (string) –
    • Description (string) –
    • ExpirationTime (string) –
    • Name (string) –
    • Nrn (string) –
    • ResourceVersion (string) –
    • Status (string) –
    • Tags (list) –
      • (dict) –
        • Id (string) –
        • Key (string) –
        • Value (string) –

delete_snapshots(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_snapshots(
    Names='string'
)

Parameters:Names (string) – Return type:dict Returns:Response Syntax

{
    'Snapshots': [
        {
            'Cluster': {
                'KubernetesVersion': 'string',
                'Name': 'string',
                'NodePools': [
                    {
                        'InstanceType': 'string',
                        'Name': 'string',
                        'NodeCount': 123
                    },
                ]
            },
            'CreateTime': 'string',
            'Description': 'string',
            'ExpirationTime': 'string',
            'Name': 'string',
            'Nrn': 'string',
            'ResourceVersion': 'string',
            'Status': 'string',
            'Tags': [
                {
                    'Id': 'string',
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
}

Response Structure

• (dict) –
  • Snapshots (list) –
    • (dict) –
      • Cluster (dict) –
        • KubernetesVersion (string) –
        • Name (string) –
        • NodePools (list) –
          • (dict) –
            • InstanceType (string) –
            • Name (string) –
            • NodeCount (integer) –
      • CreateTime (string) –
      • Description (string) –
      • ExpirationTime (string) –
      • Name (string) –
      • Nrn (string) –
      • ResourceVersion (string) –
      • Status (string) –
      • Tags (list) –
        • (dict) –
          • Id (string) –
          • Key (string) –
          • Value (string) –

delete_tags(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_tags(
    Ids='string'
)

Parameters:Ids (string) – [REQUIRED] Return type:dict Returns:Response Syntax

{
    'Tags': [
        {
            'Id': 'string',
            'Key': 'string',
            'Nrn': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

• (dict) –
  • Tags (list) –
    • (dict) –
      • Id (string) –
      • Key (string) –
      • Nrn (string) –
      • Value (string) –

detach_disk(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.detach_disk(
    DiskName='string',
    NodeName='string'
)

Parameters:

• DiskName (string) – [REQUIRED]
• NodeName (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'Disk': {
        'Attachments': [
            {
                'AttachTime': 'string',
                'DevicePath': 'string',
                'NodeName': 'string',
                'Status': 'string'
            },
        ],
        'AvailabilityZone': 'string',
        'Cluster': {
            'Name': 'string'
        },
        'CreateTime': 'string',
        'Description': 'string',
        'Name': 'string',
        'Nrn': 'string',
        'Size': 123,
        'Status': 'string',
        'Tags': [
            {
                'Id': 'string',
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'Type': 'string'
    }
}

Response Structure

• (dict) –
  • Disk (dict) –
    • Attachments (list) –
      • (dict) –
        • AttachTime (string) –
        • DevicePath (string) –
        • NodeName (string) –
        • Status (string) –
    • AvailabilityZone (string) –
    • Cluster (dict) –
      • Name (string) –
    • CreateTime (string) –
    • Description (string) –
    • Name (string) –
    • Nrn (string) –
    • Size (integer) –
    • Status (string) –
    • Tags (list) –
      • (dict) –
        • Id (string) –
        • Key (string) –
        • Value (string) –
    • Type (string) –

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters:

• ClientMethod (string) – The client method to presign for
• Params (dict) – The parameters normally passed to ClientMethod.
• ExpiresIn (int) – The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
• HttpMethod (string) – The http method to use on the generated url. By default, the http method is whatever is used in the method’s model.

Returns:

The presigned url

get_cluster(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.get_cluster(
    ClusterName='string'
)

Parameters:ClusterName (string) – [REQUIRED] Return type:dict Returns:Response Syntax

{
    'Cluster': {
        '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) –
  • Cluster (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) –

get_cluster_credentials(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.get_cluster_credentials(
    ClusterName='string'
)

Parameters:ClusterName (string) – [REQUIRED] Return type:dict Returns:Response Syntax

{
    'Credentials': 'string'
}

Response Structure

• (dict) –
  • Credentials (string) –

get_disk(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.get_disk(
    DiskName='string'
)

Parameters:DiskName (string) – [REQUIRED] Return type:dict Returns:Response Syntax

{
    'Disk': {
        'Attachments': [
            {
                'AttachTime': 'string',
                'DevicePath': 'string',
                'NodeName': 'string',
                'Status': 'string'
            },
        ],
        'AvailabilityZone': 'string',
        'Cluster': {
            'Name': 'string'
        },
        'CreateTime': 'string',
        'Description': 'string',
        'Name': 'string',
        'Nrn': 'string',
        'Size': 123,
        'Status': 'string',
        'Tags': [
            {
                'Id': 'string',
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'Type': 'string'
    }
}

Response Structure

• (dict) –
  • Disk (dict) –
    • Attachments (list) –
      • (dict) –
        • AttachTime (string) –
        • DevicePath (string) –
        • NodeName (string) –
        • Status (string) –
    • AvailabilityZone (string) –
    • Cluster (dict) –
      • Name (string) –
    • CreateTime (string) –
    • Description (string) –
    • Name (string) –
    • Nrn (string) –
    • Size (integer) –
    • Status (string) –
    • Tags (list) –
      • (dict) –
        • Id (string) –
        • Key (string) –
        • Value (string) –
    • Type (string) –

get_firewall_group(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.get_firewall_group(
    FirewallGroupName='string'
)

Parameters:FirewallGroupName (string) – [REQUIRED] Return type:dict Returns:Response Syntax

{
    'FirewallGroup': {
        'Description': 'string',
        'Name': 'string',
        'Nrn': 'string',
        'Rules': [
            {
                'CidrIp': 'string',
                'Description': 'string',
                'Direction': 'string',
                'FromPort': 123,
                'Id': 'string',
                'Protocol': 'string',
                'Status': 'string',
                'ToPort': 123
            },
        ],
        'Tags': [
            {
                'Id': 'string',
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

• (dict) –
  • FirewallGroup (dict) –
    • Description (string) –
    • Name (string) –
    • Nrn (string) –
    • Rules (list) –
      • (dict) –
        • CidrIp (string) –
        • Description (string) –
        • Direction (string) –
        • FromPort (integer) –
        • Id (string) –
        • Protocol (string) –
        • Status (string) –
        • ToPort (integer) –
    • Tags (list) –
      • (dict) –
        • Id (string) –
        • Key (string) –
        • Value (string) –

get_load_balancer(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.get_load_balancer(
    InstancePort=123,
    LoadBalancerName='string',
    LoadBalancerPort=123
)

Parameters:

• InstancePort (integer) – [REQUIRED]
• LoadBalancerName (string) – [REQUIRED]
• LoadBalancerPort (integer) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'LoadBalancers': {
        'AccountingType': 123,
        'AvailabilityZones': [
            'string',
        ],
        'Clusters': [
            {
                'Name': 'string',
                'NodePools': [
                    {
                        'Name': 'string',
                        'NodeCount': 123,
                        'Nodes': [
                            {
                                'AvailabilityZone': 'string',
                                'HealthCheckState': 'string',
                                'Name': 'string',
                                'PublicIpAddress': 'string'
                            },
                        ]
                    },
                ]
            },
        ],
        'CreatedTime': 'string',
        'Description': 'string',
        'DnsName': 'string',
        'Filter': {
            'FilterType': 'string',
            'IpAddresses': 'string'
        },
        'HealthCheck': {
            'HealthyThreshold': 123,
            'Interval': 123,
            'Target': 'string',
            'Timeout': 123,
            'UnhealthyThreshold': 123
        },
        'ListenerDescriptions': [
            {
                'Listener': {
                    'BalancingType': 'string',
                    'InstancePort': 'string',
                    'LoadBalancerPort': 'string',
                    'Protocol': 'string',
                    'SslCertificateId': 'string'
                }
            },
        ],
        'LoadBalancerName': 'string',
        'NetworkVolume': 'string',
        'NextMonthAccountingType': 123,
        'Option': {
            'SessionStickinessPolicy': {
                'Enabled': True|False,
                'ExpirationPeriod': 123
            },
            'SorryPage': {
                'Enabled': True|False,
                'StatusCode': 123
            }
        },
        'PolicyType': 'string'
    }
}

Response Structure

• (dict) –
  • LoadBalancers (dict) –
    • AccountingType (integer) –
    • AvailabilityZones (list) –
      • (string) –
    • Clusters (list) –
      • (dict) –
        • Name (string) –
        • NodePools (list) –
          • (dict) –
            • Name (string) –
            • NodeCount (integer) –
            • Nodes (list) –
              • (dict) –
                • AvailabilityZone (string) –
                • HealthCheckState (string) –
                • Name (string) –
                • PublicIpAddress (string) –
    • CreatedTime (string) –
    • Description (string) –
    • DnsName (string) –
    • Filter (dict) –
      • FilterType (string) –
      • IpAddresses (string) –
    • HealthCheck (dict) –
      • HealthyThreshold (integer) –
      • Interval (integer) –
      • Target (string) –
      • Timeout (integer) –
      • UnhealthyThreshold (integer) –
    • ListenerDescriptions (list) –
      • (dict) –
        • Listener (dict) –
          • BalancingType (string) –
          • InstancePort (string) –
          • LoadBalancerPort (string) –
          • Protocol (string) –
          • SslCertificateId (string) –
    • LoadBalancerName (string) –
    • NetworkVolume (string) –
    • NextMonthAccountingType (integer) –
    • Option (dict) –
      • SessionStickinessPolicy (dict) –
        • Enabled (boolean) –
        • ExpirationPeriod (integer) –
      • SorryPage (dict) –
        • Enabled (boolean) –
        • StatusCode (integer) –
    • PolicyType (string) –

get_node_pool(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.get_node_pool(
    ClusterName='string',
    NodePoolName='string'
)

Parameters:

• ClusterName (string) – [REQUIRED]
• NodePoolName (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'NodePool': {
        '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'
            },
        ]
    }
}

Response Structure

• (dict) –
  • NodePool (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) –

get_paginator(operation_name)

Create a paginator for an operation.

Parameters:operation_name (string) – The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you’d normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo"). Raises:OperationNotPageableError – Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable. Return type:L{botocore.paginate.Paginator} Returns:A paginator object.

get_server_config()

See also: NIFCLOUD API Documentation

Request Syntax

response = client.get_server_config()

Return type:dict Returns:Response Syntax

{
    'ServerConfig': {
        'DefaultKubernetesVersion': 'string',
        'ValidKubernetesVersions': [
            'string',
        ]
    }
}

Response Structure

• (dict) –
  • ServerConfig (dict) –
    • DefaultKubernetesVersion (string) –
    • ValidKubernetesVersions (list) –
      • (string) –

get_snapshot(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.get_snapshot(
    SnapshotName='string'
)

Parameters:SnapshotName (string) – [REQUIRED] Return type:dict Returns:Response Syntax

{
    'Snapshot': {
        'Cluster': {
            'KubernetesVersion': 'string',
            'Name': 'string',
            'NodePools': [
                {
                    'InstanceType': 'string',
                    'Name': 'string',
                    'NodeCount': 123
                },
            ]
        },
        'CreateTime': 'string',
        'Description': 'string',
        'ExpirationTime': 'string',
        'Name': 'string',
        'Nrn': 'string',
        'ResourceVersion': 'string',
        'Status': 'string',
        'Tags': [
            {
                'Id': 'string',
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

• (dict) –
  • Snapshot (dict) –
    • Cluster (dict) –
      • KubernetesVersion (string) –
      • Name (string) –
      • NodePools (list) –
        • (dict) –
          • InstanceType (string) –
          • Name (string) –
          • NodeCount (integer) –
    • CreateTime (string) –
    • Description (string) –
    • ExpirationTime (string) –
    • Name (string) –
    • Nrn (string) –
    • ResourceVersion (string) –
    • Status (string) –
    • Tags (list) –
      • (dict) –
        • Id (string) –
        • Key (string) –
        • Value (string) –

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters:waiter_name (str) – The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns:The specified waiter object. Return type:botocore.waiter.Waiter

list_clusters(**kwargs)

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) –

list_disks(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

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

Parameters:Filters (string) – Return type:dict Returns:Response Syntax

{
    'Disks': [
        {
            'Attachments': [
                {
                    'AttachTime': 'string',
                    'DevicePath': 'string',
                    'NodeName': 'string',
                    'Status': 'string'
                },
            ],
            'AvailabilityZone': 'string',
            'Cluster': {
                'Name': 'string'
            },
            'CreateTime': 'string',
            'Description': 'string',
            'Name': 'string',
            'Nrn': 'string',
            'Size': 123,
            'Status': 'string',
            'Tags': [
                {
                    'Id': 'string',
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'Type': 'string'
        },
    ]
}

Response Structure

• (dict) –
  • Disks (list) –
    • (dict) –
      • Attachments (list) –
        • (dict) –
          • AttachTime (string) –
          • DevicePath (string) –
          • NodeName (string) –
          • Status (string) –
      • AvailabilityZone (string) –
      • Cluster (dict) –
        • Name (string) –
      • CreateTime (string) –
      • Description (string) –
      • Name (string) –
      • Nrn (string) –
      • Size (integer) –
      • Status (string) –
      • Tags (list) –
        • (dict) –
          • Id (string) –
          • Key (string) –
          • Value (string) –
      • Type (string) –

list_firewall_groups(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

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

Parameters:Filters (string) – Return type:dict Returns:Response Syntax

{
    'FirewallGroups': [
        {
            'Description': 'string',
            'Name': 'string',
            'Nrn': 'string',
            'Rules': [
                {
                    'CidrIp': 'string',
                    'Description': 'string',
                    'Direction': 'string',
                    'FromPort': 123,
                    'Id': 'string',
                    'Protocol': 'string',
                    'Status': 'string',
                    'ToPort': 123
                },
            ],
            'Tags': [
                {
                    'Id': 'string',
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
}

Response Structure

• (dict) –
  • FirewallGroups (list) –
    • (dict) –
      • Description (string) –
      • Name (string) –
      • Nrn (string) –
      • Rules (list) –
        • (dict) –
          • CidrIp (string) –
          • Description (string) –
          • Direction (string) –
          • FromPort (integer) –
          • Id (string) –
          • Protocol (string) –
          • Status (string) –
          • ToPort (integer) –
      • Tags (list) –
        • (dict) –
          • Id (string) –
          • Key (string) –
          • Value (string) –

list_load_balancers()

See also: NIFCLOUD API Documentation

Request Syntax

response = client.list_load_balancers()

Return type:dict Returns:Response Syntax

{
    'LoadBalancers': [
        {
            'AccountingType': 123,
            'AvailabilityZones': [
                'string',
            ],
            'Clusters': [
                {
                    'Name': 'string',
                    'NodePools': [
                        {
                            'Name': 'string',
                            'NodeCount': 123,
                            'Nodes': [
                                {
                                    'AvailabilityZone': 'string',
                                    'HealthCheckState': 'string',
                                    'Name': 'string',
                                    'PublicIpAddress': 'string'
                                },
                            ]
                        },
                    ]
                },
            ],
            'CreatedTime': 'string',
            'Description': 'string',
            'DnsName': 'string',
            'Filter': {
                'FilterType': 'string',
                'IpAddresses': 'string'
            },
            'HealthCheck': {
                'HealthyThreshold': 123,
                'Interval': 123,
                'Target': 'string',
                'Timeout': 123,
                'UnhealthyThreshold': 123
            },
            'ListenerDescriptions': [
                {
                    'Listener': {
                        'BalancingType': 'string',
                        'InstancePort': 'string',
                        'LoadBalancerPort': 'string',
                        'Protocol': 'string',
                        'SslCertificateId': 'string'
                    }
                },
            ],
            'LoadBalancerName': 'string',
            'NetworkVolume': 'string',
            'NextMonthAccountingType': 123,
            'Option': {
                'SessionStickinessPolicy': {
                    'Enabled': True|False,
                    'ExpirationPeriod': 123
                },
                'SorryPage': {
                    'Enabled': True|False,
                    'StatusCode': 123
                }
            },
            'PolicyType': 'string'
        },
    ]
}

Response Structure

• (dict) –
  • LoadBalancers (list) –
    • (dict) –
      • AccountingType (integer) –
      • AvailabilityZones (list) –
        • (string) –
      • Clusters (list) –
        • (dict) –
          • Name (string) –
          • NodePools (list) –
            • (dict) –
              • Name (string) –
              • NodeCount (integer) –
              • Nodes (list) –
                • (dict) –
                  • AvailabilityZone (string) –
                  • HealthCheckState (string) –
                  • Name (string) –
                  • PublicIpAddress (string) –
      • CreatedTime (string) –
      • Description (string) –
      • DnsName (string) –
      • Filter (dict) –
        • FilterType (string) –
        • IpAddresses (string) –
      • HealthCheck (dict) –
        • HealthyThreshold (integer) –
        • Interval (integer) –
        • Target (string) –
        • Timeout (integer) –
        • UnhealthyThreshold (integer) –
      • ListenerDescriptions (list) –
        • (dict) –
          • Listener (dict) –
            • BalancingType (string) –
            • InstancePort (string) –
            • LoadBalancerPort (string) –
            • Protocol (string) –
            • SslCertificateId (string) –
      • LoadBalancerName (string) –
      • NetworkVolume (string) –
      • NextMonthAccountingType (integer) –
      • Option (dict) –
        • SessionStickinessPolicy (dict) –
          • Enabled (boolean) –
          • ExpirationPeriod (integer) –
        • SorryPage (dict) –
          • Enabled (boolean) –
          • StatusCode (integer) –
      • PolicyType (string) –

list_node_pools(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.list_node_pools(
    ClusterName='string',
    Filters='string'
)

Parameters:

• ClusterName (string) – [REQUIRED]
• Filters (string) –

Return type:

dict

Returns:

Response Syntax

{
    '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'
                },
            ]
        },
    ]
}

Response Structure

• (dict) –
  • 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) –

list_snapshots(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

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

Parameters:Filters (string) – Return type:dict Returns:Response Syntax

{
    'Snapshots': [
        {
            'Cluster': {
                'KubernetesVersion': 'string',
                'Name': 'string',
                'NodePools': [
                    {
                        'InstanceType': 'string',
                        'Name': 'string',
                        'NodeCount': 123
                    },
                ]
            },
            'CreateTime': 'string',
            'Description': 'string',
            'ExpirationTime': 'string',
            'Name': 'string',
            'Nrn': 'string',
            'ResourceVersion': 'string',
            'Status': 'string',
            'Tags': [
                {
                    'Id': 'string',
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
}

Response Structure

• (dict) –
  • Snapshots (list) –
    • (dict) –
      • Cluster (dict) –
        • KubernetesVersion (string) –
        • Name (string) –
        • NodePools (list) –
          • (dict) –
            • InstanceType (string) –
            • Name (string) –
            • NodeCount (integer) –
      • CreateTime (string) –
      • Description (string) –
      • ExpirationTime (string) –
      • Name (string) –
      • Nrn (string) –
      • ResourceVersion (string) –
      • Status (string) –
      • Tags (list) –
        • (dict) –
          • Id (string) –
          • Key (string) –
          • Value (string) –

list_tags(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.list_tags(
    Nrn='string'
)

Parameters:Nrn (string) – Return type:dict Returns:Response Syntax

{
    'Tags': [
        {
            'Id': 'string',
            'Key': 'string',
            'Nrn': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

• (dict) –
  • Tags (list) –
    • (dict) –
      • Id (string) –
      • Key (string) –
      • Nrn (string) –
      • Value (string) –

reboot_node(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.reboot_node(
    ClusterName='string',
    Force=True|False,
    NodeName='string',
    NodePoolName='string'
)

Parameters:

• ClusterName (string) – [REQUIRED]
• Force (boolean) –
• NodeName (string) – [REQUIRED]
• NodePoolName (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'Node': {
        'AvailabilityZone': 'string',
        'Name': 'string',
        'PrivateIpAddress': 'string',
        'PublicIpAddress': 'string',
        'Status': 'string'
    }
}

Response Structure

• (dict) –
  • Node (dict) –
    • AvailabilityZone (string) –
    • Name (string) –
    • PrivateIpAddress (string) –
    • PublicIpAddress (string) –
    • Status (string) –

restore_cluster_from_snapshot(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.restore_cluster_from_snapshot(
    Cluster={
        'Description': 'string',
        'FirewallGroup': 'string',
        'ListOfRequestLocations': [
            'string',
        ],
        'ListOfRequestTags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'Name': 'string',
        'RequestAddonsConfig': {
            'RequestHttpLoadBalancing': {
                'Disabled': True|False
            }
        },
        'RequestNetworkConfig': {
            'NetworkId': 'string'
        }
    },
    SnapshotName='string'
)

Parameters:

• Cluster (dict) –

  [REQUIRED]

  • Description (string) –
  • FirewallGroup (string) – [REQUIRED]
  • ListOfRequestLocations (list) – [REQUIRED]
    • (string) –
  • ListOfRequestTags (list) –
    • (dict) –
      • Key (string) –
      • Value (string) –
  • Name (string) – [REQUIRED]
  • RequestAddonsConfig (dict) –
    • RequestHttpLoadBalancing (dict) –
      • Disabled (boolean) –
  • RequestNetworkConfig (dict) –
    • NetworkId (string) –
• SnapshotName (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'Cluster': {
        '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) –
  • Cluster (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) –

revoke_firewall_group(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.revoke_firewall_group(
    FirewallGroupName='string',
    Ids='string'
)

Parameters:

• FirewallGroupName (string) – [REQUIRED]
• Ids (string) –

Return type:

dict

Returns:

Response Syntax

{
    'FirewallGroup': {
        'Description': 'string',
        'Name': 'string',
        'Nrn': 'string',
        'Rules': [
            {
                'CidrIp': 'string',
                'Description': 'string',
                'Direction': 'string',
                'FromPort': 123,
                'Id': 'string',
                'Protocol': 'string',
                'Status': 'string',
                'ToPort': 123
            },
        ],
        'Tags': [
            {
                'Id': 'string',
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

• (dict) –
  • FirewallGroup (dict) –
    • Description (string) –
    • Name (string) –
    • Nrn (string) –
    • Rules (list) –
      • (dict) –
        • CidrIp (string) –
        • Description (string) –
        • Direction (string) –
        • FromPort (integer) –
        • Id (string) –
        • Protocol (string) –
        • Status (string) –
        • ToPort (integer) –
    • Tags (list) –
      • (dict) –
        • Id (string) –
        • Key (string) –
        • Value (string) –

set_node_pool_size(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.set_node_pool_size(
    ClusterName='string',
    NodeCount=123,
    NodePoolName='string'
)

Parameters:

• ClusterName (string) – [REQUIRED]
• NodeCount (integer) – [REQUIRED]
• NodePoolName (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'NodePool': {
        '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'
            },
        ]
    }
}

Response Structure

• (dict) –
  • NodePool (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) –

update_cluster(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.update_cluster(
    Cluster={
        'Description': 'string',
        'KubernetesVersion': 'v1.23.3'|'v1.23.9'|'v1.24.3',
        'ListOfRequestTags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'Name': 'string',
        'RequestAddonsConfig': {
            'RequestHttpLoadBalancing': {
                'Disabled': True|False
            }
        }
    },
    ClusterName='string'
)

Parameters:

• Cluster (dict) –
  • Description (string) –
  • KubernetesVersion (string) –
  • ListOfRequestTags (list) –
    • (dict) –
      • Key (string) –
      • Value (string) –
  • Name (string) –
  • RequestAddonsConfig (dict) –
    • RequestHttpLoadBalancing (dict) –
      • Disabled (boolean) –
• ClusterName (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'Cluster': {
        '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) –
  • Cluster (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) –

update_disk(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.update_disk(
    Disk={
        'Description': 'string',
        'ListOfRequestTags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'Name': 'string',
        'Size': 123
    },
    DiskName='string'
)

Parameters:

• Disk (dict) –
  • Description (string) –
  • ListOfRequestTags (list) –
    • (dict) –
      • Key (string) –
      • Value (string) –
  • Name (string) –
  • Size (integer) –
• DiskName (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'Disk': {
        'Attachments': [
            {
                'AttachTime': 'string',
                'DevicePath': 'string',
                'NodeName': 'string',
                'Status': 'string'
            },
        ],
        'AvailabilityZone': 'string',
        'Cluster': {
            'Name': 'string'
        },
        'CreateTime': 'string',
        'Description': 'string',
        'Name': 'string',
        'Nrn': 'string',
        'Size': 123,
        'Status': 'string',
        'Tags': [
            {
                'Id': 'string',
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'Type': 'string'
    }
}

Response Structure

• (dict) –
  • Disk (dict) –
    • Attachments (list) –
      • (dict) –
        • AttachTime (string) –
        • DevicePath (string) –
        • NodeName (string) –
        • Status (string) –
    • AvailabilityZone (string) –
    • Cluster (dict) –
      • Name (string) –
    • CreateTime (string) –
    • Description (string) –
    • Name (string) –
    • Nrn (string) –
    • Size (integer) –
    • Status (string) –
    • Tags (list) –
      • (dict) –
        • Id (string) –
        • Key (string) –
        • Value (string) –
    • Type (string) –

update_firewall_group(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.update_firewall_group(
    FirewallGroup={
        'Description': 'string',
        'ListOfRequestTags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'Name': 'string'
    },
    FirewallGroupName='string'
)

Parameters:

• FirewallGroup (dict) –
  • Description (string) –
  • ListOfRequestTags (list) –
    • (dict) –
      • Key (string) –
      • Value (string) –
  • Name (string) –
• FirewallGroupName (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'FirewallGroup': {
        'Description': 'string',
        'Name': 'string',
        'Nrn': 'string',
        'Rules': [
            {
                'CidrIp': 'string',
                'Description': 'string',
                'Direction': 'string',
                'FromPort': 123,
                'Id': 'string',
                'Protocol': 'string',
                'Status': 'string',
                'ToPort': 123
            },
        ],
        'Tags': [
            {
                'Id': 'string',
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

• (dict) –
  • FirewallGroup (dict) –
    • Description (string) –
    • Name (string) –
    • Nrn (string) –
    • Rules (list) –
      • (dict) –
        • CidrIp (string) –
        • Description (string) –
        • Direction (string) –
        • FromPort (integer) –
        • Id (string) –
        • Protocol (string) –
        • Status (string) –
        • ToPort (integer) –
    • Tags (list) –
      • (dict) –
        • Id (string) –
        • Key (string) –
        • Value (string) –

update_node_pool(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.update_node_pool(
    ClusterName='string',
    NodePool={
        'ListOfRequestTags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    },
    NodePoolName='string'
)

Parameters:

• ClusterName (string) – [REQUIRED]
• NodePool (dict) –
  • ListOfRequestTags (list) –
    • (dict) –
      • Key (string) –
      • Value (string) –
• NodePoolName (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'NodePool': {
        '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'
            },
        ]
    }
}

Response Structure

• (dict) –
  • NodePool (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) –

update_snapshot(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.update_snapshot(
    Snapshot={
        'Description': 'string',
        'ExpirationTime': 'string',
        'ListOfRequestTags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'Name': 'string'
    },
    SnapshotName='string'
)

Parameters:

• Snapshot (dict) –
  • Description (string) –
  • ExpirationTime (string) –
  • ListOfRequestTags (list) –
    • (dict) –
      • Key (string) –
      • Value (string) –
  • Name (string) –
• SnapshotName (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'Snapshot': {
        'Cluster': {
            'KubernetesVersion': 'string',
            'Name': 'string',
            'NodePools': [
                {
                    'InstanceType': 'string',
                    'Name': 'string',
                    'NodeCount': 123
                },
            ]
        },
        'CreateTime': 'string',
        'Description': 'string',
        'ExpirationTime': 'string',
        'Name': 'string',
        'Nrn': 'string',
        'ResourceVersion': 'string',
        'Status': 'string',
        'Tags': [
            {
                'Id': 'string',
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

• (dict) –
  • Snapshot (dict) –
    • Cluster (dict) –
      • KubernetesVersion (string) –
      • Name (string) –
      • NodePools (list) –
        • (dict) –
          • InstanceType (string) –
          • Name (string) –
          • NodeCount (integer) –
    • CreateTime (string) –
    • Description (string) –
    • ExpirationTime (string) –
    • Name (string) –
    • Nrn (string) –
    • ResourceVersion (string) –
    • Status (string) –
    • Tags (list) –
      • (dict) –
        • Id (string) –
        • Key (string) –
        • Value (string) –

update_tags(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.update_tags(
    Tags=[
        {
            'Key': 'string',
            'Nrn': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:Tags (list) –

[REQUIRED]

• (dict) –
  • Key (string) – [REQUIRED]
  • Nrn (string) – [REQUIRED]
  • Value (string) – [REQUIRED]

Return type:dict Returns:Response Syntax

{
    'Tags': [
        {
            'Id': 'string',
            'Key': 'string',
            'Nrn': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

• (dict) –
  • Tags (list) –
    • (dict) –
      • Id (string) –
      • Key (string) –
      • Nrn (string) –
      • Value (string) –

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

This client has no modeled exception classes.

Waiters

The available waiters are:

• hatoba.Waiter.ClusterDeleted
• hatoba.Waiter.ClusterRunning
• hatoba.Waiter.FirewallRuleAuthorized
• hatoba.Waiter.SnapshotAvailable

class hatoba.Waiter.ClusterDeleted

waiter = client.get_waiter('cluster_deleted')

wait(**kwargs)

Polls hatoba.Client.get_cluster() every 30 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    ClusterName='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:

• ClusterName (string) – [REQUIRED]
• WaiterConfig (dict) –

  A dictionary that provides parameters to control waiting behavior.

  • Delay (integer) –

    The amount of time in seconds to wait between attempts. Default: 30

  • MaxAttempts (integer) –

    The maximum number of attempts to be made. Default: 40

Returns:

None

class hatoba.Waiter.ClusterRunning

waiter = client.get_waiter('cluster_running')

wait(**kwargs)

Polls hatoba.Client.get_cluster() every 60 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    ClusterName='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:

• ClusterName (string) – [REQUIRED]
• WaiterConfig (dict) –

  A dictionary that provides parameters to control waiting behavior.

  • Delay (integer) –

    The amount of time in seconds to wait between attempts. Default: 60

  • MaxAttempts (integer) –

    The maximum number of attempts to be made. Default: 40

Returns:

None

class hatoba.Waiter.FirewallRuleAuthorized

waiter = client.get_waiter('firewall_rule_authorized')

wait(**kwargs)

Polls hatoba.Client.get_firewall_group() every 20 seconds until a successful state is reached. An error is returned after 20 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    FirewallGroupName='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:

• FirewallGroupName (string) – [REQUIRED]
• WaiterConfig (dict) –

  A dictionary that provides parameters to control waiting behavior.

  • Delay (integer) –

    The amount of time in seconds to wait between attempts. Default: 20

  • MaxAttempts (integer) –

    The maximum number of attempts to be made. Default: 20

Returns:

None

class hatoba.Waiter.SnapshotAvailable

waiter = client.get_waiter('snapshot_available')

wait(**kwargs)

Polls hatoba.Client.get_snapshot() every 20 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    SnapshotName='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:

• SnapshotName (string) – [REQUIRED]
• WaiterConfig (dict) –

  A dictionary that provides parameters to control waiting behavior.

  • Delay (integer) –

    The amount of time in seconds to wait between attempts. Default: 20

  • MaxAttempts (integer) –

    The maximum number of attempts to be made. Default: 40

Returns:

None