:DescribeNetworkInterfaces

Usage notes

You can call the DescribeNetworkInterfaces operation for paged query by specifying the MaxResults or NextToken parameter. During a paged query, when you call the DescribeNetworkInterfaces operation to retrieve the first page of results, set MaxResults to specify the maximum number of entries to return in the call. The return value of NextToken is a pagination token that can be used in the next call to retrieve a new page of results. When you call the DescribeNetworkInterfaces operation to retrieve a new page of results, set NextToken to the NextToken value returned in the previous call and set MaxResults to specify the maximum number of entries to return in this call.

Request parameters

Response parameters

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=DescribeNetworkInterfaces
&RegionId=cn-hangzhou
&PrivateIpAddress.1=192.168.**.**
&PrivateIpAddress.2=192.168.**.**
&NextToken=AAAAAdDWBF2****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeNetworkInterfacesResponse>
    <NextToken>AAAAAdDWBF2****</NextToken>
    <PageSize>1</PageSize>
    <PageNumber>1</PageNumber>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <TotalCount>2</TotalCount>
    <NetworkInterfaceSets>
        <CreationTime>2019-12-25T12:31:31Z</CreationTime>
        <VpcId>vpc-bp1j7w3gc1cexjqd****</VpcId>
        <Type>Secondary</Type>
        <Status>Available</Status>
        <NetworkInterfaceTrafficMode>Standard</NetworkInterfaceTrafficMode>
        <NetworkInterfaceName>my-eni-name</NetworkInterfaceName>
        <MacAddress>00:16:3e:12:**:**</MacAddress>
        <QueuePairNumber>0</QueuePairNumber>
        <NetworkInterfaceId>eni-bp125p95hhdhn3ot****</NetworkInterfaceId>
        <ServiceID>12345678910</ServiceID>
        <InstanceId>i-bp1e2l6djkndyuli****</InstanceId>
        <OwnerId>123456****</OwnerId>
        <ServiceManaged>true</ServiceManaged>
        <VSwitchId>vsw-bp16usj2p27htro3****</VSwitchId>
        <Description>DescriptionTest</Description>
        <ResourceGroupId>rg-2ze88m67qx5z****</ResourceGroupId>
        <ZoneId>cn-hangzhou-e</ZoneId>
        <PrivateIpAddress>172.17.**.**</PrivateIpAddress>
        <QueueNumber>8</QueueNumber>
        <PrivateIpSets>
            <PrivateIpAddress>172.17.**.**</PrivateIpAddress>
            <Primary>true</Primary>
            <AssociatedPublicIp>
                <PublicIpAddress>116.62.**.**</PublicIpAddress>
                <AllocationId>null</AllocationId>
            </AssociatedPublicIp>
        </PrivateIpSets>
        <Ipv6Sets>
            <Ipv6Address>2408:4321:180:1701:94c7:bc38:3bfa:****</Ipv6Address>
        </Ipv6Sets>
        <Ipv4PrefixSets>
            <Ipv4Prefix>192.168.**.0/28</Ipv4Prefix>
        </Ipv4PrefixSets>
        <Ipv6PrefixSets>
            <Ipv6Prefix>2001:db8:1234:1a00:****::/80</Ipv6Prefix>
        </Ipv6PrefixSets>
        <Tags>
            <TagValue>TestValue</TagValue>
            <TagKey>TestKey</TagKey>
        </Tags>
        <SecurityGroupIds>sg-bp18kz60mefsicfg****</SecurityGroupIds>
        <AssociatedPublicIp>
            <PublicIpAddress>116.62.**.**</PublicIpAddress>
            <AllocationId>null</AllocationId>
        </AssociatedPublicIp>
        <Attachment>
            <DeviceIndex>0</DeviceIndex>
            <InstanceId>null</InstanceId>
            <TrunkNetworkInterfaceId>null</TrunkNetworkInterfaceId>
            <NetworkCardIndex>0</NetworkCardIndex>
            <DeleteOnRelease>true</DeleteOnRelease>
        </Attachment>
    </NetworkInterfaceSets>
</DescribeNetworkInterfacesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NextToken" : "AAAAAdDWBF2****",
  "PageSize" : 1,
  "PageNumber" : 1,
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount" : 2,
  "NetworkInterfaceSets" : [ {
    "CreationTime" : "2019-12-25T12:31:31Z",
    "VpcId" : "vpc-bp1j7w3gc1cexjqd****",
    "Type" : "Secondary",
    "Status" : "Available",
    "NetworkInterfaceTrafficMode" : "Standard",
    "NetworkInterfaceName" : "my-eni-name",
    "MacAddress" : "00:16:3e:12:**:**",
    "QueuePairNumber" : 0,
    "NetworkInterfaceId" : "eni-bp125p95hhdhn3ot****",
    "ServiceID" : 12345678910,
    "InstanceId" : "i-bp1e2l6djkndyuli****",
    "OwnerId" : "123456****",
    "ServiceManaged" : true,
    "VSwitchId" : "vsw-bp16usj2p27htro3****",
    "Description" : "DescriptionTest",
    "ResourceGroupId" : "rg-2ze88m67qx5z****",
    "ZoneId" : "cn-hangzhou-e",
    "PrivateIpAddress" : "172.17.**.**",
    "QueueNumber" : 8,
    "PrivateIpSets" : [ {
      "PrivateIpAddress" : "172.17.**.**",
      "Primary" : true,
      "AssociatedPublicIp" : {
        "PublicIpAddress" : "116.62.**.**",
        "AllocationId" : "null"
      }
    } ],
    "Ipv6Sets" : [ {
      "Ipv6Address" : "2408:4321:180:1701:94c7:bc38:3bfa:****"
    } ],
    "Ipv4PrefixSets" : [ {
      "Ipv4Prefix" : "192.168.**.0/28"
    } ],
    "Ipv6PrefixSets" : [ {
      "Ipv6Prefix" : "2001:db8:1234:1a00:****::/80"
    } ],
    "Tags" : [ {
      "TagValue" : "TestValue",
      "TagKey" : "TestKey"
    } ],
    "SecurityGroupIds" : [ "sg-bp18kz60mefsicfg****" ],
    "AssociatedPublicIp" : {
      "PublicIpAddress" : "116.62.**.**",
      "AllocationId" : "null"
    },
    "Attachment" : {
      "DeviceIndex" : 0,
      "InstanceId" : "null",
      "TrunkNetworkInterfaceId" : "null",
      "NetworkCardIndex" : 0,
      "DeleteOnRelease" : "true"
    }
  } ]
}

Error codes

For a list of error codes, see Service error codes.