调用DescribeNetworkInterfaces查看弹性网卡(ENI)列表。

接口说明

DescribeNetworkInterfaces支持两种查看返回数据的方式:

  • 方式一:通过NextToken设置查询凭证(Token),其取值是上一次调用DescribeNetworkInterfaces返回的NextToken参数值,再通过MaxResults设置单页查询的最大条目数。
  • 方式二:通过PageSize设置单页返回的条目数,再通过PageNumber设置页码。

    以上两种方式只能任选其中之一。当弹性网卡返回的条目数较多时,推荐使用方式一。如果设置了NextToken,则请求参数PageSizePageNumber将失效,且返回数据中的TotalCount无效。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeNetworkInterfaces

系统规定参数。取值:DescribeNetworkInterfaces

RegionId String cn-hangzhou

所在地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

Tag.N.Key String test

弹性网卡的标签值。N的取值范围:1~20。

Tag.N.Value String api-test

弹性网卡的标签键。N的取值范围:1~20。

ResourceGroupId String rg-bp67acfmxazb4ph***

资源组ID。

VSwitchId String vsw-bp16usj2p27htro3*****

VPC的交换机ID。

VpcId String vsw-bp16usj2p27htro3*****

网卡所属的专有网络VPC ID。

PrimaryIpAddress String 192.168.1.2

弹性网卡主私网IP地址。

PrivateIpAddress.N RepeatList 192.168.1.1

弹性网卡的辅助私网IP地址,N的取值范围:1~100。

SecurityGroupId String sg-bp144yr32sx6ndw*****

安全组ID。

NetworkInterfaceName String my-eni-name

弹性网卡的名称。

Type String Secondary

弹性网卡类型。取值范围:

  • Primary:主网卡。
  • Secondary:辅助弹性网卡。
InstanceId String i-bp1e2l6djkndyulib***

弹性网卡当前关联的实例ID。

NetworkInterfaceId.N RepeatList eni-bp125p95hhdhn3otz***

弹性网卡ID。N的取值范围:1~100。

ServiceManaged Boolean true

该弹性网卡的使用者是否为云产品或虚商。

PageNumber Integer 1

查询结果的页码。

起始值:1。

默认值:1。

PageSize Integer 100

查询结果的分页大小。

最大值:100。

默认值:10。

有关本接口查看返回数据的设置方式,请参见上文接口说明。

NextToken String AAAAAdDWBF2****w==

查询凭证(Token),取值为上一次API调用返回的NextToken参数值。

有关本接口查看返回数据的设置方式,请参见上文接口说明。

MaxResults Integer 50

返回的最大数。取值范围:1~500

默认值:10。

返回数据

名称 类型 示例值 描述
NetworkInterfaceSets Array

弹性网卡信息组成的集合。

NetworkInterfaceSet
AssociatedPublicIp Struct

弹性网卡辅助私有IP地址关联的公网IP。

AllocationId String eip-2ze88m67qx5z*****

EIP的ID。

PublicIpAddress String 116.62.129.***

公网IP地址。

CreationTime String 2017-11-24T06:14:22Z

创建时间。

Description String test

描述。

InstanceId String i-bp1e2l6djkndyulib***

弹性网卡绑定的实例ID。

说明 由其他阿里云服务管理和控制的弹性网卡不会返回实例ID。
Ipv6Sets Array

为弹性网卡分配的IPv6地址集合。

Ipv6Set
Ipv6Address String 2001:db8:1234:1a00::***

为弹性网卡指定的IPv6地址。

MacAddress String 2001:db8:1234:1a00::***

为弹性网卡指定的IPv6地址。

NetworkInterfaceId String eni-bp125p95hhdhn3otz***

弹性网卡ID。

NetworkInterfaceName String my-eni-name

弹性网卡的名称。

OwnerId String 123456789

弹性网卡的所属账号ID。

PrivateIpAddress String 172.17.**.***

弹性网卡的私网IP地址。

PrivateIpSets Array

PrivateIp组成的集合。

PrivateIpSet
AssociatedPublicIp Struct

弹性网卡关联的公有IP。

AllocationId String eip-2ze88m67qx5z*****

EIP的ID。

PublicIpAddress String 116.62.**.250

实例的公网IP。

Primary Boolean true

是否是主IP地址。

PrivateIpAddress String 172.17.**.***

实例的私网IP地址。

QueueNumber Integer 2

弹性网卡的队列号。

ResourceGroupId String rg-2ze88m67qx5z*****

资源组ID。

SecurityGroupIds List sg-bp18kz60mefsicfgo***

所属的安全组集合。

ServiceID Long 123456789

弹性网卡对应的虚商ID。

ServiceManaged Boolean true

该弹性网卡的使用者是否为云产品或虚商。

Status String Available

弹性网卡的状态。

Tags Array

标签。

Tag
TagKey String test

标签键。

TagValue String api

标签值。

Type String Secondary

弹性网卡的类型。

VSwitchId String vsw-bp16usj2p27htro3*****

VPC的虚拟交换机ID。

VpcId String vpc-bp1j7w3gc1cexjqd*****

网卡所属的专有网络VPC ID。

ZoneId String cn-hangzhou-e

可用区ID。

NextToken String AAAAAdDWBF2****w==

本次调用返回的查询凭证值。

PageNumber Integer 1

返回数据列表页码。

PageSize Integer 1

查询时设置的每页行数。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

TotalCount Integer 70

返回的弹性网卡总数。

示例

请求示例

https://ecs.aliyuncs.com/?Action=DescribeNetworkInterfaces
&RegionId=cn-hangzhou
&PrivateIpAddress.1=192.168.1.1
&PrivateIpAddress.2=192.168.1.2
&NextToken=AAAAAdDWBF2****w==
&<公共请求参数>

正常返回示例

XML 格式

<DescribeNetworkInterfacesResponse>
      <PageNumber>1</PageNumber>
      <NextToken>AAAAAdDWBF2w6Olxc+cMPjUtUMoOHldehKPIfYtMyAi+***w+IDifXafILjY/QdPWM1nUw==</NextToken>
      <TotalCount>0</TotalCount>
      <PageSize>10</PageSize>
      <RequestId>F5266102-405B-4EEC-AAD8-ADF227463EA9</RequestId>
      <NetworkInterfaceSets>
            <NetworkInterfaceSet>
                  <Type>Primary</Type>
                  <ResourceGroupId></ResourceGroupId>
                  <InstanceId>i-bp188rg4xz5qev******</InstanceId>
                  <PrivateIpSets>
                        <PrivateIpSet>
                              <PrivateIpAddress>172.16.***.99</PrivateIpAddress>
                              <Primary>true</Primary>
                              <AssociatedPublicIp></AssociatedPublicIp>
                        </PrivateIpSet>
                  </PrivateIpSets>
                  <ZoneId>cn-hangzhou-g</ZoneId>
                  <VSwitchId>vsw-bp1s5fnvk4gn2tw******</VSwitchId>
                  <VpcId>vpc-bp1opxu1zkhn00g******</VpcId>
                  <AssociatedPublicIp></AssociatedPublicIp>
                  <NetworkInterfaceId>eni-bp14664y88uf9t******</NetworkInterfaceId>
                  <CreationTime>2018-11-09T13:56:24Z</CreationTime>
                  <Status>InUse</Status>
                  <MacAddress>00:16:3e:15:40:5d</MacAddress>
                  <SecurityGroupIds>
                        <SecurityGroupId>sg-bp10zcgmybh0qc******</SecurityGroupId>
                  </SecurityGroupIds>
                  <PrivateIpAddress>172.16.***.99</PrivateIpAddress>
            </NetworkInterfaceSet>
      </NetworkInterfaceSets>
</DescribeNetworkInterfacesResponse>

JSON 格式

{
	"PageNumber": 1,
	"NextToken": "AAAAAdDWBF2w6Olxc+cMPjUtUMoOHldehKPIfYtMyAi+***w+IDifXafILjY/QdPWM1nUw==",
	"TotalCount": 0,
	"PageSize": 10,
	"RequestId": "F5266102-405B-4EEC-AAD8-ADF227463EA9",
	"NetworkInterfaceSets": {
		"NetworkInterfaceSet": [
			{
				"Type": "Primary",
				"ResourceGroupId": "",
				"InstanceId": "i-bp188rg4xz5qev******",
				"PrivateIpSets": {
					"PrivateIpSet": [
						{
							"PrivateIpAddress": "172.16.***.99",
							"Primary": true,
							"AssociatedPublicIp": {}
						}
					]
				},
				"ZoneId": "cn-hangzhou-g",
				"VSwitchId": "vsw-bp1s5fnvk4gn2tw******",
				"VpcId": "vpc-bp1opxu1zkhn00g******",
				"AssociatedPublicIp": {},
				"NetworkInterfaceId": "eni-bp14664y88uf9t******",
				"CreationTime": "2018-11-09T13:56:24Z",
				"Status": "InUse",
				"MacAddress": "00:16:3e:15:40:5d",
				"SecurityGroupIds": {
					"SecurityGroupId": [
						"sg-bp10zcgmybh0qc******"
					]
				},
				"PrivateIpAddress": "172.16.***.99"
			}
		]
	}
}

错误码

HttpCode 错误码 错误信息 描述
403 InvalidUserType.NotSupported %s 您当前的账号不支持此操作。
403 Abs.InvalidAccount.NotFound %s 您的阿里云账号不存在,或者您的AccessKey已经过期。
400 MissingParameter %s 缺失参数,请检查参数是否完整。
403 Forbidden.NotSupportRAM %s 暂不支持 RAM 用户执行该操作。
400 UnsupportedParameter %s 不支持参数。
403 Forbidden.SubUser %s 您的账号没有操作此资源的权限,请向主账号申请相关的权限。
400 InvalidParameter %s 无效的参数。
400 InvalidInstanceID.Malformed %s 参数“InstanceId”格式错误。
400 InvalidOperation.InvalidEcsState %s 实例当前的状态不支持此操作。
400 InvalidOperation.InvalidEniState %s 弹性网卡当前的状态不支持此操作。
400 InvalidOperation.DetachPrimaryEniNotAllowed %s 不允许解绑实例的主网卡。
404 InvalidEcsId.NotFound %s 指定的实例 ID 不存在。
404 InvalidEniId.NotFound %s 指定的弹性网卡 ID 不存在。
404 InvalidVSwitchId.NotFound %s 指定的交换机不存在。
404 InvalidSecurityGroupId.NotFound %s 指定的安全组 ID 不存在。
403 MaxEniCountExceeded %s 超过可以操作的最大弹性网卡数
403 EniPerInstanceLimitExceeded %s 实例绑定的弹性网卡数量已经达到了最大限度,不能在为实例绑定弹性网卡。
403 InvalidOperation.AvailabilityZoneMismatch %s 该操作无效。
403 InvalidOperation.VpcMismatch %s 您的操作无效,请确认该操作中的 VPC 与其它参数是否匹配。
403 SecurityGroupInstanceLimitExceed %s 该安全组内已有的实例数量已达到最大限制。
403 InvalidSecurityGroupId.NotVpc %s 参数“SecurityGroupId”无效,该安全组的网络类型不是专有网络。
403 InvalidOperation.InvalidEniType %s 当前弹性网卡的类型不支持此操作。
400 Forbidden.RegionId %s 当前地域暂时没有提供该服务。

访问错误中心查看更多错误码。