computing / Client / describe_addresses

describe_addresses

computing.Client.describe_addresses(**kwargs)

付替IPアドレスの情報を取得します。

付替IPアドレスを指定しない場合は、取得可能なすべての付替グローバルIPアドレス・プライベートIPアドレス情報を取得します。

また付替IPアドレスを指定する際、ワイルドカード文字（曖昧検索）指定可能です。「*」は0個以上任意文字、 「?」は1個任意文字となります。

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_addresses(
    AllocationId=[
        'string',
    ],
    Filter=[
        {
            'ListOfRequestValue': [
                'string',
            ],
            'Name': 'string'
        },
    ],
    PrivateIpAddress=[
        'string',
    ],
    PublicIp=[
        'string',
    ]
)

Parameters:

• AllocationId (list) –

  • (string) –

• Filter (list) –

  • (dict) –

    • ListOfRequestValue (list) –

      • (string) –

    • Name (string) –

• PrivateIpAddress (list) –

  • (string) –

• PublicIp (list) –

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'AddressesSet': [
        {
            'AvailabilityZone': 'string',
            'Description': 'string',
            'InstanceId': 'string',
            'InstanceUniqueId': 'string',
            'PrivateIpAddress': 'string',
            'PublicIp': 'string'
        },
    ],
    'RequestId': 'string'
}

Response Structure

• (dict) –

  • AddressesSet (list) –

    • (dict) –

      • AvailabilityZone (string) –

      • Description (string) –

      • InstanceId (string) –

      • InstanceUniqueId (string) –

      • PrivateIpAddress (string) –

      • PublicIp (string) –

  • RequestId (string) –