DescribeNetworkInterfaces

Description

• You can specify attribute values to filter the results.
• If no attribute values are specified, all ENIs are returned.
• You can query a maximum of 100 ENIs at a time.

Debugging

You can use API Explorer to perform debugging. API Explorer allows you to perform various operations to simplify API usage. For example, you can call APIs, dynamically generate SDK example code, and quickly retrieve APIs.

Request parameters

Response parameters

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=DescribeNetworkInterfaces
&RegionId=cn-hangzhou 
&Tag.1.Key=test
&Tag.1.Value=api
&ResourceGroupId=rg-resourcegroupid1
&VSwitchId=vsw-bp16usj2p27htro3xxxxx
&VpcId=vsw-bp16usj2p27htro3xxxxx
&PrimaryIpAddress=172.17. XX.XXX
&SecurityGroupId=sg-bp144yr32sx6ndwxxxxx
&NetworkInterfaceName=my-eni-name
&Type=Secondary
&InstanceId=AY121018033933eaxxxxx
&NetworkInterfaceId. 1=eni-bp17pdijfczaxZZZZxxxxx
&PageNumber=1
&PageSize=100
&<Common request parameters>

Successful response examples

XML format

<DescribeNetworkInterfacesResponse>
  <NetworkInterfaceSets> 
    <NetworkInterfaceSet> 
      <AssociatedPublicIp/> 
      <CreationTime>2017-11-24T06:14:22Z</CreationTime> 
      <InstanceId>AY121018033933eaxxxxx</InstanceId> 
      <MacAddress>00:16:3e:0f:XX:XX</MacAddress> 
      <NetworkInterfaceId>eni-bp17pdijfczaxZZZZxxxxx</NetworkInterfaceId> 
      <PrivateIpAddress>XXX.XXX.XX.XX</PrivateIpAddress> 
      <PrivateIpSets>
        <PrivateIpSet>
          <AssociatedPublicIp/> 
          <Primary>true</Primary> 
          <PrivateIpAddress>XXX.XXX.XX.XX</PrivateIpAddress> 
        </PrivateIpSet>
      </PrivateIpSets> 
      <SecurityGroupIds> 
        <SecurityGroupId>sg-bp144yr32sx6ndwxxxxx</SecurityGroupId> 
      </SecurityGroupIds>
      <Status>Available</Status> 
      <Type>Secondary</Type> 
      <VpcId>vpc-bp1j7w3gc1cexjqdxxxxx</VpcId> 
      <VSwitchId>vsw-bp16usj2p27htro3xxxxx</VSwitchId> 
      <ZoneId>cn-hangzhou-e</ZoneId> 
    </NetworkInterfaceSet> 
  </NetworkInterfaceSets>
  <PageNumber>1</PageNumber> 
  <PageSize>100</PageSize> 
  <RequestId>CEE5C347-0B64-4535-A061-95BE95Axxxxx</RequestId> 
  <TotalCount>1</TotalCount> 
</DescribeNetworkInterfacesResponse>

JSON format

{
	"PageNumber":1,
	"TotalCount":1,
	"PageSize":100,
	"RequestId":"CEE5C347-0B64-4535-A061-95BE95Axxxxx",
	"NetworkInterfaceSets":{
		"NetworkInterfaceSet":[
			{
				"Type":"Secondary",
				"InstanceId":"AY121018033933eaxxxxx",
				"PrivateIpSets":{
					"PrivateIpSet":[
						{
							"PrivateIpAddress":"XXX.XXX.XX.XX",
							"Primary":true,
							"AssociatedPublicIp":{}
						}
					]
				},
				"ZoneId":"cn-hangzhou-e",
				"VSwitchId":"vsw-bp16usj2p27htro3xxxxx",
				"VpcId":"vpc-bp1j7w3gc1cexjqdxxxxx",
				"AssociatedPublicIp":{},
				"NetworkInterfaceId":"eni-bp17pdijfczaxZZZZxxxxx",
				"CreationTime":"2017-11-24T06:14:22Z",
				"Status":"Available",
				"MacAddress":"00:16:3e:0f:XX:XX",
				"SecurityGroupIds":{
					"SecurityGroupId":[
						"sg-bp144yr32sx6ndwxxxxx"
					]
				},
				"PrivateIpAddress":"XXX.XXX.XX.XX"
			}
		]
	}
}

Error codes

View error codes