DescribeNetworkInterfaces

Description

call DescribeNetworkInterfaces to view the list of flexible network cards (ENI).

Request Method

POST

Request Path

/apsara/route/Ecs/DescribeNetworkInterfaces

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
Status	BODY	string	No	InUse	network card status. Value range: Creating: Creating Available: not mounted Attaching: Mount InUse: mounted Detaching: Separating Deleting: Deleting CreateFailed: creation failed and belongs to abnormal state default value: empty, indicating that all states are queried.
Tag.N.Key	BODY	string	No	TestKey	the tag value of the flexible network card. The value range of n is 1~20.
ResourceGroupId	BODY	string	No	rg-bp67acfmxazb4p****	resource group ID.
ServiceManaged	BODY	boolean	No	true	whether the user of the flexible network card is a cloud product or a virtual vendor.
PageSize	BODY	integer	No	100	the paging size of the query result. maximum value: 100. default value: 10. /p> p data-tag = "p" class = "p"> please refer to the interface description above for setting the returned data in this interface.
NextToken	BODY	string	No	AAAAAdDWBF2****	query credentials (Token), the value is NextToken parameter value returned from the last API call. /span>/p> p data-tag = "p" class = "p"> please refer to the interface description above for setting the returned data.
InstanceId	BODY	string	No	i-bp1e2l6djkndyuli****	the instance ID currently associated with the ENI.
VSwitchId	BODY	string	No	vsw-bp16usj2p27htro3****	VPC switch ID.
SecurityGroupId	BODY	string	No	sg-bp144yr32sx6ndw****	security group ID.
MaxResults	BODY	integer	No	50	The maximum number returned. Value range: 1~500. default value: 10.
NetworkInterfaceName	BODY	string	No	my-eni-name	the name of the elastic network card.
PrimaryIpAddress	BODY	string	No	192.168.*.*	the IP address of the flexible network card.
version	BODY	string	No	2016-01-01	version of api
Type	BODY	string	No	Secondary	flexible network card type. Value range: Primary: primary network card Secondary: auxiliary flexible network card default value: empty, indicating that all types are queried.
VpcId	BODY	string	No	vpc-wz9wh0fywtu5szszb****	VPC ID of the network to which the network card belongs.
PageNumber	BODY	integer	No	1	the page number of the query result. starting value: 1. default value: 1.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
Tag.N.Value	BODY	string	No	TestValue	tag key of elastic network card. The value range of n is 1~20.
PrivateIpAddress.N	BODY	repeatlist	No	192.168.*.*	the secondary private IP address of the flexible network card, the value range of n is 1~100.
NetworkInterfaceId.N	BODY	repeatlist	No	eni-bp125p95hhdhn3ot****	ENI ID. The value range of n is 1~100.
RegionId	BODY	string	Yes	cn-qingdao-env17-d01	region ID. You can call the DescribeRegions to view the latest Alibaba Cloud region list.

Return data

Name	Type	Sample value	Description
RequestID	string	1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC	Request id

Example

Successful Response example

{
 "RequestID":"1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}