DescribeNetworkInterfaceAttribute - 查询网卡属性_云服务器 ECS(ECS)-阿里云帮助中心

调用DescribeNetworkInterfaceAttribute查询指定网卡详细信息。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ecs:DescribeNetworkInterfaceAttribute	READ	NetworkInterface acs:ecs:{#regionId}:{#accountId}:eni/{#eniId}	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	弹性网卡所在地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
Tag	array<object>	否	说明该参数暂未开放使用。
	object	否	说明该参数暂未开放使用。
Key	string	否	说明该参数暂未开放使用。	TestKey
Value	string	否	说明该参数暂未开放使用。	TestValue
NetworkInterfaceId	string	是	弹性网卡 ID。	eni-bp67acfmxazb4p****
Attribute	string	否	弹性网卡属性，取值范围： attachment：查询成员网卡的挂载信息。说明该参数正在邀测中，暂未开放使用。	attachment

返回参数

名称	类型	描述	示例值
	object	该参数暂未开放使用。
ConnectionTrackingConfiguration	object	该参数暂未开放使用。
TcpClosedAndTimeWaitTimeout	integer	该参数暂未开放使用。
TcpEstablishedTimeout	integer	该参数暂未开放使用。
UdpTimeout	integer	该参数暂未开放使用。
CreationTime	string	弹性网卡的创建时间。	2019-12-25T12:31:31Z
VpcId	string	弹性网卡所属的专有网络 VPC ID。	vpc-bp67acfmxazb4p****
Type	string	弹性网卡类型。可能值： Primary：主网卡。 Secondary：辅助弹性网卡。	Secondary
Status	string	弹性网卡的状态。可能值： Available：可用。 Attaching：附加中。 InUse：已附加。 Detaching：分离中。 Deleting：删除中。默认值：空，表示查询所有状态。	Available
NetworkInterfaceTrafficConfig	object	弹性网卡通讯参数
NetworkInterfaceTrafficMode	string	弹性网卡的通讯模式。	HighPerformance
QueueNumber	integer	弹性网卡队列数。	8
QueuePairNumber	integer	RDMA 网卡队列数。	8
NetworkInterfaceTrafficMode	string	弹性网卡的通讯模式。可能值： Standard：使用 TCP 通讯模式。 HighPerformance：开启 ERI（Elastic RDMA Interface）接口，使用 RDMA 通讯模式。说明 HighPerformance 参数值只支持 RDMA 增强型实例规格族 c7re，目前仅支持在华北 2（北京）的可用区 K 设置该参数值。	Standard
NetworkInterfaceName	string	弹性网卡名称。	my-eni-name
MacAddress	string	弹性网卡的 MAC 地址。	00:16:3e:12::
QueuePairNumber	integer	说明该参数正在邀测中，暂未开放使用。	22
NetworkInterfaceId	string	弹性网卡的 ID。	eni-bp125p95hhdhn3ot****
ServiceID	long	弹性网卡对应的虚商 ID。	12345678910
InstanceId	string	弹性网卡附加的实例 ID。说明由其他阿里云服务管理和控制的弹性网卡不会返回实例 ID。	i-bp1e2l6djkndyuli****
OwnerId	string	弹性网卡的所属账号 ID。	123456****
ServiceManaged	boolean	该弹性网卡的使用者是否为云产品或虚商。	true
VSwitchId	string	弹性网卡所属的交换机 ID。	vsw-bp1s5fnvk4gn2tws0****
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
Description	string	弹性网卡描述。	testDescription
ResourceGroupId	string	实例所属的企业资源组 ID。使用该参数过滤资源时，资源数量不能超过 1000 个。说明不支持默认资源组过滤。	rg-bp67acfmxazb4p****
ZoneId	string	可用区 ID。	cn-hangzhou-g
PrivateIpAddress	string	弹性网卡的私网 IP 地址。	10.1..
QueueNumber	integer	弹性网卡的队列数。弹性网卡为主网卡：返回实例规格默认的主网卡队列数。弹性网卡为辅助网卡：辅助网卡是已附加（InUse）状态：辅助网卡没有修改过队列数，则返回实例规格默认的辅助网卡队列数。辅助网卡修改过队列数，则返回修改后的队列数。辅助网卡是可用（Available）状态：辅助网卡未修改过队列数，则返回值为空。辅助网卡修改过队列数，则返回修改后的队列数。	8
SecurityGroupIds	array	弹性网卡所属的安全组集合。
	string	弹性网卡所属的安全组。	sg-bp18kz60mefsicfg****
AssociatedPublicIp	object	弹性网卡辅助私有 IP 地址关联的弹性公网 IP。
PublicIpAddress	string	弹性公网 IP 地址。	116.62..
AllocationId	string	弹性公网 IP 的 ID。	null
Attachment	object	说明该参数正在邀测中，暂未开放使用。
DeviceIndex	integer	说明该参数正在邀测中，暂未开放使用。	hide
InstanceId	string	说明该参数正在邀测中，暂未开放使用。	hide
TrunkNetworkInterfaceId	string	说明该参数正在邀测中，暂未开放使用。	hide
MemberNetworkInterfaceIds	array	说明该参数正在邀测中，暂未开放使用。
	string	说明该参数正在邀测中，暂未开放使用。	hide
NetworkCardIndex	integer	网卡挂载指定的物理网卡索引。如果网卡是未挂载（Available）状态或者挂载时未指定索引，则不返回此值。如果网卡是已挂载（InUse）状态且挂载时指定，此值表示网卡挂载指定的物理网卡索引。	0
PrivateIpSets	array<object>	PrivateIpSet 组成的集合。
	object	PrivateIpSet 组成的集合。
PrivateIpAddress	string	弹性网卡的私网 IP 地址。	172.17..
Primary	boolean	是否是主私网 IP 地址。可能值： true：主私网 IP。 false：辅助私网 IP。	true
AssociatedPublicIp	object	弹性网卡辅助私有 IP 地址关联的弹性公网 IP。
PublicIpAddress	string	弹性公网 IP 地址。	116.62..
AllocationId	string	说明该参数正在邀测中，暂未开放使用。	null
Ipv6Sets	array<object>	弹性网卡已分配的 IPv6 地址。
	object	弹性网卡已分配的 ipv6 地址。
Ipv6Address	string	为弹性网卡指定的 IPv6 地址。	2001:db8:1234:1a00::****
Ipv4PrefixSets	array<object>	弹性网卡已分配的 IPv4 前缀集合。
	object
Ipv4Prefix	string	弹性网卡已分配的 IPv4 前缀。	192.168.**.0/28
Ipv6PrefixSets	array<object>	弹性网卡已分配的 IPv6 前缀集合。
	object
Ipv6Prefix	string	弹性网卡已分配的 IPv6 前缀。	2001:db8:1234:1a00:****::/80
Tags	array<object>	弹性网卡的标签集合。
	object	弹性网卡的标签集合。
TagValue	string	标签值。	TestValue
TagKey	string	标签键。	TestKey
BondInterfaceSpecification	object	说明该参数正在邀测中，暂未开放使用。
BondMode	string	说明该参数正在邀测中，暂未开放使用。	null
SlaveInterfaceSpecification	array<object>	说明该参数正在邀测中，暂未开放使用。
	object	说明该参数正在邀测中，暂未开放使用。
SlaveNetworkInterfaceId	string	说明该参数正在邀测中，暂未开放使用。	null
WorkState	string	说明该参数正在邀测中，暂未开放使用。	null
BondNetworkInterfaceId	string	说明该参数正在邀测中，暂未开放使用。	null
SlaveInterfaceSpecification	object	说明该参数正在邀测中，暂未开放使用。
SlaveNetworkInterfaceId	string	说明该参数正在邀测中，暂未开放使用。	null
WorkState	string	说明该参数正在邀测中，暂未开放使用。	null
BondNetworkInterfaceId	string	说明该参数正在邀测中，暂未开放使用。	null
DeleteOnRelease	boolean	释放实例时是否保留网卡。可能值： true：不保留。 false：保留。	true
TcpOptionAddressEnabled	string	说明该参数正在邀测中，暂未开放使用。	null
EnhancedNetwork	object	该参数暂未开放使用。
EnableSriov	boolean	该参数暂未开放使用。

示例

正常返回示例

JSON格式

{
  "ConnectionTrackingConfiguration": {
    "TcpClosedAndTimeWaitTimeout": 0,
    "TcpEstablishedTimeout": 0,
    "UdpTimeout": 0
  },
  "CreationTime": "2019-12-25T12:31:31Z",
  "VpcId": "vpc-bp67acfmxazb4p****",
  "Type": "Secondary",
  "Status": "Available",
  "NetworkInterfaceTrafficConfig": {
    "NetworkInterfaceTrafficMode": "HighPerformance",
    "QueueNumber": 8,
    "QueuePairNumber": 8
  },
  "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": {
    "SecurityGroupId": [
      "sg-bp18kz60mefsicfg****"
    ]
  },
  "AssociatedPublicIp": {
    "PublicIpAddress": "116.62.**.**",
    "AllocationId": "null"
  },
  "Attachment": {
    "DeviceIndex": 0,
    "InstanceId": "hide",
    "TrunkNetworkInterfaceId": "hide",
    "MemberNetworkInterfaceIds": {
      "MemberNetworkInterfaceId": [
        "hide"
      ]
    },
    "NetworkCardIndex": 0
  },
  "PrivateIpSets": {
    "PrivateIpSet": [
      {
        "PrivateIpAddress": "172.17.**.**",
        "Primary": true,
        "AssociatedPublicIp": {
          "PublicIpAddress": "116.62.**.**",
          "AllocationId": "null"
        }
      }
    ]
  },
  "Ipv6Sets": {
    "Ipv6Set": [
      {
        "Ipv6Address": "2001:db8:1234:1a00::****"
      }
    ]
  },
  "Ipv4PrefixSets": {
    "Ipv4PrefixSet": [
      {
        "Ipv4Prefix": "192.168.**.0/28"
      }
    ]
  },
  "Ipv6PrefixSets": {
    "Ipv6PrefixSet": [
      {
        "Ipv6Prefix": "2001:db8:1234:1a00:****::/80"
      }
    ]
  },
  "Tags": {
    "Tag": [
      {
        "TagValue": "TestValue",
        "TagKey": "TestKey"
      }
    ]
  },
  "BondInterfaceSpecification": {
    "BondMode": "null",
    "SlaveInterfaceSpecification": {
      "SlaveInterfaceSpecificationSet": [
        {
          "SlaveNetworkInterfaceId": "null",
          "WorkState": "null",
          "BondNetworkInterfaceId": "null"
        }
      ]
    }
  },
  "SlaveInterfaceSpecification": {
    "SlaveNetworkInterfaceId": "null",
    "WorkState": "null",
    "BondNetworkInterfaceId": "null"
  },
  "DeleteOnRelease": true,
  "TcpOptionAddressEnabled": "null",
  "EnhancedNetwork": {
    "EnableSriov": true
  }
}

错误码

HTTP status code	错误码	错误信息	描述
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 不存在。

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

变更历史

变更时间	变更内容概要	操作
2024-07-03	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-05-17	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-05-07	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-02-01	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-10-09	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-01-04	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情