调用DescribeNetworkInterfaces查询一个或多个弹性网卡(ENI)的详细信息。

接口说明

DescribeNetworkInterfaces接口支持分页查询。具体使用说明:分页查询首页时,仅需设置MaxResults以限制返回信息的条目数,返回结果中的NextToken将作为查询后续页的凭证。查询后续页时,将NextToken参数设置为上一次返回结果中获取到的NextToken作为查询凭证,并设置MaxResults限制返回条目数。

说明 当指定MaxResultsNextToken参数时,系统会使用上述的分页查询方式返回结果,否则系统会使用PageNumberPageSize组成的分页查询方式返回结果。

调试

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

请求参数

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

系统规定参数。取值:DescribeNetworkInterfaces

RegionId String cn-hangzhou

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

ResourceGroupId String rg-bp67acfmxazb4p****

资源组ID。使用该参数过滤资源时,资源数量不能超过1000个。

VSwitchId String vsw-bp16usj2p27htro3****

弹性网卡所属的交换机ID。

VpcId String vsw-bp16usj2p27htro3****

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

PrimaryIpAddress String 192.168.**.**

弹性网卡主私网IPv4地址。

SecurityGroupId String sg-bp144yr32sx6ndw****

辅助网卡对应的安全组ID。

  • 如果您需要通过安全组ID查询辅助网卡的信息,请指定该参数。
  • 如果您需要通过安全组ID查询主网卡信息,请调用DescribeInstances指定SecurityGroupId参数进行查询。
NetworkInterfaceName String test-eni-name

弹性网卡的名称。

Type String Secondary

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

  • Primary:主网卡。
  • Secondary:辅助网卡。

默认值:空,表示查询所有类型。

InstanceId String i-bp1e2l6djkndyuli****

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

ServiceManaged Boolean true

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

Status String Available

弹性网卡的状态。取值范围:

  • Available:可用。
  • Attaching:绑定中。
  • InUse:已绑定。
  • Detaching:解绑中。
  • Deleting:删除中。

默认值:空,表示查询所有状态。

PageNumber Integer 1

查询结果的页码。

起始值:1。

默认值:1。

说明 该参数即将下线,推荐您使用NextToken与MaxResults完成分页查询操作。
PageSize Integer 100

查询结果的分页大小。

最大值:1000。

默认值:10。

说明 该参数即将下线,推荐您使用NextToken与MaxResults完成分页查询操作。
NextToken String AAAAAdDWBF2****

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

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

MaxResults Integer 50

分页查询时每页的最大条目数。取值范围:10~500。

默认值:

  • 当不设置值或设置的值小于10时,默认值为10。
  • 当设置的值大于500时,默认值为500。
Tag.N.Key String TestKey

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

Tag.N.Value String TestValue

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

使用一个标签过滤资源,查询到该标签下的资源数量不能超过1000个;使用多个标签过滤资源,查询到同时绑定了多个标签的资源数量不能超过1000个。如果资源数量超过1000个,请使用ListTagResources接口进行查询。

PrivateIpAddress.N String 192.168.**.**

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

NetworkInterfaceId.N String eni-bp125p95hhdhn3ot****

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

Ipv6Address.N String 2408:4321:180:1701:94c7:bc38:3bfa:****

弹性网卡的IPv6地址。N表示可以设置多个IPv6地址,N的取值范围:1~100。

返回数据

名称 类型 示例值 描述
NextToken String AAAAAdDWBF2****

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

PageSize Integer 1

分页查询参数。

说明 该参数即将下线,推荐您使用NextToken与MaxResults完成分页查询操作。
PageNumber Integer 1

分页查询参数。

说明 该参数即将下线,推荐您使用NextToken与MaxResults完成分页查询操作。
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

TotalCount Integer 2

返回的弹性网卡总数。

说明 使用MaxResultsNextToken参数进行分页查询时,返回的TotalCount参数值无意义。
NetworkInterfaceSets Array of NetworkInterfaceSet

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

NetworkInterfaceSet
CreationTime String 2019-12-25T12:31:31Z

创建时间。

VpcId String vpc-bp1j7w3gc1cexjqd****

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

Type String Secondary

弹性网卡的类型。

Status String Available

弹性网卡的状态。

NetworkInterfaceTrafficMode String Standard

弹性网卡的通讯模式。可能值:

  • Standard:使用TCP通讯模式。
  • HighPerformance:开启ERI(Elastic RDMA Interface)接口,使用RDMA通讯模式。
    说明 HighPerformance参数值只支持RDMA增强型实例规格族c7re,目前仅支持在华北2(北京)的可用区K设置该参数值。
NetworkInterfaceName String my-eni-name

弹性网卡的名称。

MacAddress String 00:16:3e:12:**:**

弹性网卡的MAC地址。

QueuePairNumber Integer 0
说明 该参数正在邀测中,暂未开放使用。
NetworkInterfaceId String eni-bp125p95hhdhn3ot****

弹性网卡ID。

ServiceID Long 12345678910

弹性网卡对应的虚商ID。

InstanceId String i-bp1e2l6djkndyuli****

弹性网卡绑定的实例ID。

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

弹性网卡的所属账号ID。

ServiceManaged Boolean true

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

VSwitchId String vsw-bp16usj2p27htro3****

VPC的交换机ID。

Description String DescriptionTest

描述。

ResourceGroupId String rg-2ze88m67qx5z****

资源组ID。

ZoneId String cn-hangzhou-e

可用区ID。

PrivateIpAddress String 172.17.**.**

弹性网卡的私网IP地址。

QueueNumber Integer 8

弹性网卡的队列数。

  • 如果辅助网卡是已挂载(InUse)状态且没有修改过队列数,则返回实例规格默认的辅助网卡队列数。
  • 如果辅助网卡修改过队列数,则返回修改后的队列数。
  • 如果辅助网卡是未挂载(Available)状态且未修改过队列数,则返回值为空。
  • 主网卡返回实例规格默认的主网卡队列数。
PrivateIpSets Array of PrivateIpSet

PrivateIpSet组成的集合。

PrivateIpSet
PrivateIpAddress String 172.17.**.**

实例的私网IP地址。

Primary Boolean true

是否是主私网IP地址。可能值:

  • true:主私网IP
  • false:辅助私网IP
AssociatedPublicIp Object

弹性网卡关联的弹性公网IP。

PublicIpAddress String 116.62.**.**

弹性公网IP地址。

AllocationId String null
说明 该参数正在邀测中,暂未开放使用。
Ipv6Sets Array of Ipv6Set

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

Ipv6Set
Ipv6Address String 2408:4321:180:1701:94c7:bc38:3bfa:****

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

Tags Array of Tag

标签。

Tag
TagValue String TestValue

标签值。

TagKey String TestKey

标签键。

SecurityGroupIds Array of String sg-bp18kz60mefsicfg****

所属的安全组集合。

AssociatedPublicIp Object

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

PublicIpAddress String 116.62.**.**

弹性公网IP地址。

AllocationId String null
说明 该参数正在邀测中,暂未开放使用。
Attachment Object
说明 该参数正在邀测中,暂未开放使用。
DeviceIndex Integer 0
说明 该参数正在邀测中,暂未开放使用。
InstanceId String null
说明 该参数正在邀测中,暂未开放使用。
TrunkNetworkInterfaceId String null
说明 该参数正在邀测中,暂未开放使用。

示例

请求示例

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

正常返回示例

XML格式

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

<DescribeNetworkInterfacesResponse>
    <TotalCount>2</TotalCount>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <PageSize>1</PageSize>
    <NextToken>AAAAAdDWBF2****</NextToken>
    <PageNumber>1</PageNumber>
    <NetworkInterfaceSets>
        <NetworkInterfaceSet>
            <Status>Available</Status>
            <NetworkInterfaceTrafficMode>Standard</NetworkInterfaceTrafficMode>
            <ServiceManaged>false</ServiceManaged>
            <PrivateIpAddress>172.17.**.**</PrivateIpAddress>
            <ZoneId>cn-hangzhou-e</ZoneId>
            <ResourceGroupId>rg-aek2boynwys****</ResourceGroupId>
            <InstanceId>i-wz91t9p4j9xsw2pn****</InstanceId>
            <VSwitchId>vsw-bp16usj2p27htro3****</VSwitchId>
            <NetworkInterfaceId>eni-bp125p95hhdhn3ot****</NetworkInterfaceId>
            <MacAddress>00:16:3e:12:**:**</MacAddress>
            <SecurityGroupIds>
                <SecurityGroupId>sg-bp18kz60mefsicfg****</SecurityGroupId>
            </SecurityGroupIds>
            <Type>Secondary</Type>
            <Ipv6Sets>
                <Ipv6Set>
                    <Ipv6Address>2408:4321:180:1701:94c7:bc38:3bfa:****</Ipv6Address>
                </Ipv6Set>
            </Ipv6Sets>
            <VpcId>vpc-bp1j7w3gc1cexjqd****</VpcId>
            <OwnerId>123456****</OwnerId>
            <NetworkInterfaceName>my-eni-name</NetworkInterfaceName>
            <AssociatedPublicIp/>
            <CreationTime>2019-12-25T12:31:31Z</CreationTime>
            <Tags>
                <Tag>
                    <TagKey>TestKey</TagKey>
                    <TagValue>TestValue</TagValue>
                </Tag>
            </Tags>
            <PrivateIpSets>
                <PrivateIpSet>
                    <PrivateIpAddress>172.17.**.**</PrivateIpAddress>
                    <AssociatedPublicIp/>
                    <Primary>true</Primary>
                </PrivateIpSet>
            </PrivateIpSets>
        </NetworkInterfaceSet>
    </NetworkInterfaceSets>
</DescribeNetworkInterfacesResponse>

JSON格式

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

{
  "TotalCount" : 2,
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageSize" : 1,
  "NextToken" : "AAAAAdDWBF2****",
  "PageNumber" : 1,
  "NetworkInterfaceSets" : {
    "NetworkInterfaceSet" : [ {
      "Status" : "Available",
      "NetworkInterfaceTrafficMode" : "Standard",
      "ServiceManaged" : false,
      "PrivateIpAddress" : "172.17.**.**",
      "ZoneId" : "cn-hangzhou-e",
      "ResourceGroupId" : "rg-aek2boynwys****",
      "InstanceId" : "i-wz91t9p4j9xsw2pn****",
      "VSwitchId" : "vsw-bp16usj2p27htro3****",
      "NetworkInterfaceId" : "eni-bp125p95hhdhn3ot****",
      "MacAddress" : "00:16:3e:12:**:**",
      "SecurityGroupIds" : {
        "SecurityGroupId" : [ "sg-bp18kz60mefsicfg****" ]
      },
      "Type" : "Secondary",
      "Ipv6Sets" : {
        "Ipv6Set" : [ {
          "Ipv6Address" : "2408:4321:180:1701:94c7:bc38:3bfa:****"
        } ]
      },
      "VpcId" : "vpc-bp1j7w3gc1cexjqd****",
      "OwnerId" : "123456****",
      "NetworkInterfaceName" : "my-eni-name",
      "AssociatedPublicIp" : { },
      "CreationTime" : "2019-12-25T12:31:31Z",
      "Tags" : {
        "Tag" : [ {
          "TagKey" : "TestKey",
          "TagValue" : "TestValue"
        } ]
      },
      "PrivateIpSets" : {
        "PrivateIpSet" : [ {
          "PrivateIpAddress" : "172.17.**.**",
          "AssociatedPublicIp" : { },
          "Primary" : true
        } ]
      }
    } ]
  }
}

错误码

HttpCode 错误码 错误信息 描述
400 MissingParameter %s 缺失参数,请检查参数是否完整。
400 UnsupportedParameter %s 不支持参数。
400 InvalidParameter %s 无效的参数。
400 InvalidInstanceID.Malformed %s 参数InstanceId格式错误。
400 InvalidOperation.InvalidEcsState %s 实例当前的状态不支持此操作。
400 InvalidOperation.InvalidEniState %s 弹性网卡当前的状态不支持此操作。
400 InvalidOperation.DetachPrimaryEniNotAllowed %s 不允许解绑实例的主网卡。
400 Forbidden.RegionId %s 当前地域暂时没有提供该服务。
400 InvalidRegionId.MalFormed The specified parameter RegionId is not valid. 指定的RegionId不合法。
403 InvalidUserType.NotSupported %s 您当前的账号不支持此操作。
403 Abs.InvalidAccount.NotFound %s 您的阿里云账号不存在,或者您的AccessKey已经过期。
403 Forbidden.NotSupportRAM %s 暂不支持RAM用户执行该操作。
403 Forbidden.SubUser %s 您的账号没有操作此资源的权限,请向主账号申请相关的权限。
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 当前弹性网卡的类型不支持此操作。
403 InvalidVpc.Empty %s 指定的VPC下没有创建交换机,具体信息请参见错误信息%s占位符的实际返回结果。
404 InvalidEcsId.NotFound %s 指定的实例ID不存在。
404 InvalidEniId.NotFound %s 指定的弹性网卡ID不存在。
404 InvalidVSwitchId.NotFound %s 指定的交换机不存在。
404 InvalidSecurityGroupId.NotFound %s 指定的安全组ID不存在。

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