computing / Client / describe_network_interfaces

describe_network_interfaces

computing.Client.describe_network_interfaces(**kwargs)

追加NICの情報を取得します。1回のリクエストで複数の追加NICの情報を取得できます。

追加NICの情報を指定するためには、追加NICのネットワークインターフェースIDが必要です。指定しない場合は、取得可能なすべての追加NICの情報を取得します。

絞り込み条件の項目の値「Filter.n.Value.m」を指定する際、ワイルドカード文字（曖昧検索）指定可能です。「∗」は0個以上任意文字、「?」は1個任意文字、「」はエスケープ変換文字（「¥∗niftycloud¥?¥¥ 」は「∗niftycloud?¥」を検索）となります。

曖昧検索が指定可能な絞り込み条件の項目名は、attachment.instance-id、description、nifty-network-nameになります。

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_network_interfaces(
    Filter=[
        {
            'ListOfRequestValue': [
                'string',
            ],
            'Name': 'attachment.instance-id'|'availability-zone'|'description'|'network-interface-id'|'nifty-network-id'|'nifty-network-name'
        },
    ],
    NetworkInterfaceId=[
        'string',
    ]
)

Parameters:

• Filter (list) –

  • (dict) –

    • ListOfRequestValue (list) –

      • (string) –

    • Name (string) –

• NetworkInterfaceId (list) –

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'NetworkInterfaceSet': [
        {
            'Association': {
                'AllocationId': 'string',
                'AssociationId': 'string',
                'IpOwnerId': 'string',
                'PublicDnsName': 'string',
                'PublicIp': 'string',
                'PublicIpV6': 'string'
            },
            'Attachment': {
                'AttachTime': 'string',
                'AttachmentId': 'string',
                'DeleteOnTermination': 'string',
                'DeviceIndex': 'string',
                'InstanceId': 'string',
                'InstanceOwnerId': 'string',
                'Status': 'string'
            },
            'AvailabilityZone': 'string',
            'Description': 'string',
            'GroupSet': [
                {
                    'GroupId': 'string'
                },
            ],
            'InterfaceType': 'string',
            'Ipv6AddressesSet': [
                {
                    'Ipv6Address': 'string'
                },
            ],
            'MacAddress': 'string',
            'NetworkInterfaceId': 'string',
            'NiftyNetworkId': 'string',
            'NiftyNetworkName': 'string',
            'OwnerId': 'string',
            'PrivateDnsName': 'string',
            'PrivateIpAddress': 'string',
            'PrivateIpAddressV6': 'string',
            'PrivateIpAddressesSet': [
                {
                    'Association': {
                        'AllocationId': 'string',
                        'AssociationId': 'string',
                        'IpOwnerId': 'string',
                        'PublicDnsName': 'string',
                        'PublicIp': 'string',
                        'PublicIpV6': 'string'
                    },
                    'Primary': 'string',
                    'PrivateDnsName': 'string',
                    'PrivateIpAddress': 'string'
                },
            ],
            'RequesterId': 'string',
            'RequesterManaged': 'string',
            'SourceDestCheck': 'string',
            'Status': 'string',
            'SubnetId': 'string',
            'TagSet': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'VpcId': 'string'
        },
    ],
    'RequestId': 'string'
}

Response Structure

• (dict) –

  • NetworkInterfaceSet (list) –

    • (dict) –

      • Association (dict) –

        • AllocationId (string) –

        • AssociationId (string) –

        • IpOwnerId (string) –

        • PublicDnsName (string) –

        • PublicIp (string) –

        • PublicIpV6 (string) –

      • Attachment (dict) –

        • AttachTime (string) –

        • AttachmentId (string) –

        • DeleteOnTermination (string) –

        • DeviceIndex (string) –

        • InstanceId (string) –

        • InstanceOwnerId (string) –

        • Status (string) –

      • AvailabilityZone (string) –

      • Description (string) –

      • GroupSet (list) –

        • (dict) –

          • GroupId (string) –

      • InterfaceType (string) –

      • Ipv6AddressesSet (list) –

        • (dict) –

          • Ipv6Address (string) –

      • MacAddress (string) –

      • NetworkInterfaceId (string) –

      • NiftyNetworkId (string) –

      • NiftyNetworkName (string) –

      • OwnerId (string) –

      • PrivateDnsName (string) –

      • PrivateIpAddress (string) –

      • PrivateIpAddressV6 (string) –

      • PrivateIpAddressesSet (list) –

        • (dict) –

          • Association (dict) –

            • AllocationId (string) –

            • AssociationId (string) –

            • IpOwnerId (string) –

            • PublicDnsName (string) –

            • PublicIp (string) –

            • PublicIpV6 (string) –

          • Primary (string) –

          • PrivateDnsName (string) –

          • PrivateIpAddress (string) –

      • RequesterId (string) –

      • RequesterManaged (string) –

      • SourceDestCheck (string) –

      • Status (string) –

      • SubnetId (string) –

      • TagSet (list) –

        • (dict) –

          • Key (string) –

          • Value (string) –

      • VpcId (string) –

  • RequestId (string) –