DescribeNetworkInterfaceAttribute - 云服务器 ECS

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeNetworkInterfaceAttribute	系统规定参数。取值：DescribeNetworkInterfaceAttribute。
RegionId	String	是	cn-hangzhou	弹性网卡所在地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。
Tag.N.Key	String	否	TestKey	说明该参数暂未开放使用。
Tag.N.Value	String	否	TestValue	说明该参数暂未开放使用。
NetworkInterfaceId	String	是	eni-bp67acfmxazb4p****	弹性网卡ID。
Attribute	String	否	test	弹性网卡属性。

返回数据

名称	类型	示例值	描述
CreationTime	String	2019-12-25T12:31:31Z	弹性网卡的创建时间。
VpcId	String	vpc-bp67acfmxazb4p****	弹性网卡所属的专有网络VPC ID。
Type	String	Secondary	弹性网卡类型。可能值： Primary：主网卡。 Secondary：辅助弹性网卡。
Status	String	Available	弹性网卡的状态。可能值： Available：可用。 Attaching：附加中。 InUse：已附加。 Detaching：分离中。 Deleting：删除中。默认值：空，表示查询所有状态。
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	22	说明该参数正在邀测中，暂未开放使用。
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-bp1s5fnvk4gn2tws0****	弹性网卡所属的交换机ID。
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****	请求ID。
Description	String	testDescription	弹性网卡描述。
ResourceGroupId	String	rg-bp67acfmxazb4p****	实例所属的企业资源组ID。使用该参数过滤资源时，资源数量不能超过1000个。说明不支持默认资源组过滤。
ZoneId	String	cn-hangzhou-g	可用区ID。
PrivateIpAddress	String	10.1..	弹性网卡的私网IP地址。
QueueNumber	Integer	8	弹性网卡的队列数。弹性网卡为主网卡：返回实例规格默认的主网卡队列数。弹性网卡为辅助网卡：辅助网卡是已附加（InUse）状态：辅助网卡没有修改过队列数，则返回实例规格默认的辅助网卡队列数。辅助网卡修改过队列数，则返回修改后的队列数。辅助网卡是可用（Available）状态：辅助网卡未修改过队列数，则返回值为空。辅助网卡修改过队列数，则返回修改后的队列数。
SecurityGroupIds	Array of String	sg-bp18kz60mefsicfg****	弹性网卡所属的安全组。
AssociatedPublicIp	Object		弹性网卡辅助私有IP地址关联的弹性公网IP。
PublicIpAddress	String	116.62..	弹性公网IP地址。
AllocationId	String	null	弹性公网IP的ID。
Attachment	Object		说明该参数正在邀测中，暂未开放使用。
DeviceIndex	Integer	hide	说明该参数正在邀测中，暂未开放使用。
InstanceId	String	hide	说明该参数正在邀测中，暂未开放使用。
TrunkNetworkInterfaceId	String	hide	说明该参数正在邀测中，暂未开放使用。
MemberNetworkInterfaceIds	Array of String	hide	说明该参数正在邀测中，暂未开放使用。
NetworkCardIndex	Integer	0	网卡挂载指定的物理网卡索引。如果网卡是未挂载（Available）状态或者挂载时未指定索引，则不返回此值。如果网卡是已挂载（InUse）状态且挂载时指定，此值表示网卡挂载指定的物理网卡索引。
PrivateIpSets	Array of PrivateIpSet		PrivateIpSet组成的集合。
PrivateIpSet
PrivateIpAddress	String	172.17..	弹性网卡的私网IP地址。
Primary	Boolean	true	是否是主私网IP地址。可能值： true：主私网IP。 false：辅助私网IP。
AssociatedPublicIp	Object		弹性网卡辅助私有IP地址关联的弹性公网IP。
PublicIpAddress	String	116.62..	弹性公网IP地址。
AllocationId	String	null	说明该参数正在邀测中，暂未开放使用。
Ipv6Sets	Array of Ipv6Set		弹性网卡已分配的IPv6地址。
Ipv6Set
Ipv6Address	String	2001:db8:1234:1a00::****	为弹性网卡指定的IPv6地址。
Ipv4PrefixSets	Array of Ipv4PrefixSet		弹性网卡已分配的IPv4前缀集合。
Ipv4PrefixSet
Ipv4Prefix	String	192.168.**.0/28	弹性网卡已分配的IPv4前缀。
Ipv6PrefixSets	Array of Ipv6PrefixSet		弹性网卡已分配的IPv6前缀集合。
Ipv6PrefixSet
Ipv6Prefix	String	2001:db8:1234:1a00:****::/80	弹性网卡已分配的IPv6前缀。
Tags	Array of Tag		弹性网卡的标签集合。
Tag
TagValue	String	TestValue	标签值。
TagKey	String	TestKey	标签键。
BondInterfaceSpecification	Object		说明该参数正在邀测中，暂未开放使用。
BondMode	String	null	说明该参数正在邀测中，暂未开放使用。
SlaveInterfaceSpecification	Array of SlaveInterfaceSpecificationSet		说明该参数正在邀测中，暂未开放使用。
SlaveInterfaceSpecificationSet
SlaveNetworkInterfaceId	String	null	说明该参数正在邀测中，暂未开放使用。
WorkState	String	null	说明该参数正在邀测中，暂未开放使用。
BondNetworkInterfaceId	String	null	说明该参数正在邀测中，暂未开放使用。
SlaveInterfaceSpecification	Object		说明该参数正在邀测中，暂未开放使用。
SlaveNetworkInterfaceId	String	null	说明该参数正在邀测中，暂未开放使用。
WorkState	String	null	说明该参数正在邀测中，暂未开放使用。
BondNetworkInterfaceId	String	null	说明该参数正在邀测中，暂未开放使用。
DeleteOnRelease	Boolean	true	释放实例时是否保留网卡。可能值： true：不保留。 false：保留。

示例

请求示例

http(s)://ecs.aliyuncs.com/?Action=DescribeNetworkInterfaceAttribute
&RegionId=cn-hangzhou
&NetworkInterfaceId=eni-bp67acfmxazb4p****
&Attribute=test
&公共请求参数

正常返回示例

XML格式

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

<DescribeNetworkInterfaceAttributeResponse>
    <CreationTime>2019-12-25T12:31:31Z</CreationTime>
    <VpcId>vpc-bp67acfmxazb4p****</VpcId>
    <Type>Secondary</Type>
    <Status>Available</Status>
    <NetworkInterfaceTrafficMode>Standard</NetworkInterfaceTrafficMode>
    <NetworkInterfaceName>my-eni-name</NetworkInterfaceName>
    <MacAddress>00:16:3e:12:**:**</MacAddress>
    <QueuePairNumber>22</QueuePairNumber>
    <NetworkInterfaceId>eni-bp125p95hhdhn3ot****</NetworkInterfaceId>
    <ServiceID>12345678910</ServiceID>
    <InstanceId>i-bp1e2l6djkndyuli****</InstanceId>
    <OwnerId>123456****</OwnerId>
    <ServiceManaged>true</ServiceManaged>
    <VSwitchId>vsw-bp1s5fnvk4gn2tws0****</VSwitchId>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
    <Description>testDescription</Description>
    <ResourceGroupId>rg-bp67acfmxazb4p****</ResourceGroupId>
    <ZoneId>cn-hangzhou-g</ZoneId>
    <PrivateIpAddress>10.1.**.**</PrivateIpAddress>
    <QueueNumber>8</QueueNumber>
    <SecurityGroupIds>sg-bp18kz60mefsicfg****</SecurityGroupIds>
    <AssociatedPublicIp>
        <PublicIpAddress>116.62.**.**</PublicIpAddress>
        <AllocationId>null</AllocationId>
    </AssociatedPublicIp>
    <Attachment>
        <InstanceId>hide</InstanceId>
        <TrunkNetworkInterfaceId>hide</TrunkNetworkInterfaceId>
        <MemberNetworkInterfaceIds>hide</MemberNetworkInterfaceIds>
        <NetworkCardIndex>0</NetworkCardIndex>
    </Attachment>
    <PrivateIpSets>
        <PrivateIpAddress>172.17.**.**</PrivateIpAddress>
        <Primary>true</Primary>
        <AssociatedPublicIp>
            <PublicIpAddress>116.62.**.**</PublicIpAddress>
            <AllocationId>null</AllocationId>
        </AssociatedPublicIp>
    </PrivateIpSets>
    <Ipv6Sets>
        <Ipv6Address>2001:db8:1234:1a00::****</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>
    <BondInterfaceSpecification>
        <BondMode>null</BondMode>
        <SlaveInterfaceSpecification>
            <SlaveNetworkInterfaceId>null</SlaveNetworkInterfaceId>
            <WorkState>null</WorkState>
            <BondNetworkInterfaceId>null</BondNetworkInterfaceId>
        </SlaveInterfaceSpecification>
    </BondInterfaceSpecification>
    <SlaveInterfaceSpecification>
        <SlaveNetworkInterfaceId>null</SlaveNetworkInterfaceId>
        <WorkState>null</WorkState>
        <BondNetworkInterfaceId>null</BondNetworkInterfaceId>
        <DeleteOnRelease>true</DeleteOnRelease>
    </SlaveInterfaceSpecification>
</DescribeNetworkInterfaceAttributeResponse>

JSON格式

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

{
  "CreationTime" : "2019-12-25T12:31:31Z",
  "VpcId" : "vpc-bp67acfmxazb4p****",
  "Type" : "Secondary",
  "Status" : "Available",
  "NetworkInterfaceTrafficMode" : "Standard",
  "NetworkInterfaceName" : "my-eni-name",
  "MacAddress" : "00:16:3e:12:**:**",
  "QueuePairNumber" : 22,
  "NetworkInterfaceId" : "eni-bp125p95hhdhn3ot****",
  "ServiceID" : 12345678910,
  "InstanceId" : "i-bp1e2l6djkndyuli****",
  "OwnerId" : "123456****",
  "ServiceManaged" : true,
  "VSwitchId" : "vsw-bp1s5fnvk4gn2tws0****",
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "Description" : "testDescription",
  "ResourceGroupId" : "rg-bp67acfmxazb4p****",
  "ZoneId" : "cn-hangzhou-g",
  "PrivateIpAddress" : "10.1.**.**",
  "QueueNumber" : 8,
  "SecurityGroupIds" : [ "sg-bp18kz60mefsicfg****" ],
  "AssociatedPublicIp" : {
    "PublicIpAddress" : "116.62.**.**",
    "AllocationId" : "null"
  },
  "Attachment" : {
    "InstanceId" : "hide",
    "TrunkNetworkInterfaceId" : "hide",
    "MemberNetworkInterfaceIds" : [ "hide" ],
    "NetworkCardIndex" : 0
  },
  "PrivateIpSets" : [ {
    "PrivateIpAddress" : "172.17.**.**",
    "Primary" : true,
    "AssociatedPublicIp" : {
      "PublicIpAddress" : "116.62.**.**",
      "AllocationId" : "null"
    }
  } ],
  "Ipv6Sets" : [ {
    "Ipv6Address" : "2001:db8:1234:1a00::****"
  } ],
  "Ipv4PrefixSets" : [ {
    "Ipv4Prefix" : "192.168.**.0/28"
  } ],
  "Ipv6PrefixSets" : [ {
    "Ipv6Prefix" : "2001:db8:1234:1a00:****::/80"
  } ],
  "Tags" : [ {
    "TagValue" : "TestValue",
    "TagKey" : "TestKey"
  } ],
  "BondInterfaceSpecification" : {
    "BondMode" : "null",
    "SlaveInterfaceSpecification" : [ {
      "SlaveNetworkInterfaceId" : "null",
      "WorkState" : "null",
      "BondNetworkInterfaceId" : "null"
    } ]
  },
  "SlaveInterfaceSpecification" : {
    "SlaveNetworkInterfaceId" : "null",
    "WorkState" : "null",
    "BondNetworkInterfaceId" : "null",
    "DeleteOnRelease" : "true"
  }
}

错误码

HttpCode	错误码	错误信息	描述
400	MissingParameter	%s	缺失参数，请检查参数是否完整。
400	UnsupportedParameter	%s	不支持参数。
400	InvalidParameter	%s	无效的参数。
400	InvalidInstanceID.Malformed	%s	参数 InstanceId 格式错误。
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	您的账号没有操作此资源的权限，请向主账号申请相关的权限。
404	InvalidEniId.NotFound	%s	指定的弹性网卡 ID 不存在。

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