全部产品
Search
文档中心

云服务器 ECS:DescribeNetworkInterfaceAttribute - 查询网卡属性

更新时间:Nov 29, 2024

指定弹性网卡ID,查询一个网卡的详细信息。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:DescribeNetworkInterfaceAttributeget
*NetworkInterface
acs:ecs:{#regionId}:{#accountId}:eni/{#eniId}

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-hangzhou
Tagarray<object>
说明 该参数暂未开放使用。
object
说明 该参数暂未开放使用。
Keystring
说明 该参数暂未开放使用。
TestKey
Valuestring
说明 该参数暂未开放使用。
TestValue
NetworkInterfaceIdstring

弹性网卡 ID。

eni-bp67acfmxazb4p****
Attributestring

弹性网卡属性,取值范围:

attachment:查询成员网卡的挂载信息。

说明 该参数正在邀测中,暂未开放使用。
attachment

返回参数

名称类型描述示例值
object

网卡信息集合。

CreationTimestring

弹性网卡的创建时间。

2019-12-25T12:31:31Z
VpcIdstring

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

vpc-bp67acfmxazb4p****
Typestring

弹性网卡类型。可能值:

  • Primary:主网卡。
  • Secondary:辅助弹性网卡。
Secondary
Statusstring

弹性网卡的状态。可能值:

  • Available:可用。
  • Attaching:附加中。
  • InUse:已附加。
  • Detaching:分离中。
  • Deleting:删除中。

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

Available
NetworkInterfaceTrafficModestring

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

  • Standard:使用 TCP 通讯模式。
  • HighPerformance:开启 ERI(Elastic RDMA Interface)接口,使用 RDMA 通讯模式。
说明 HighPerformance 参数值只支持 RDMA 增强型实例规格族 c7re。
Standard
NetworkInterfaceNamestring

弹性网卡的名称。

my-eni-name
MacAddressstring

弹性网卡的 MAC 地址。

00:16:3e:12:**:**
QueuePairNumberinteger
说明 该参数正在邀测中,暂未开放使用。
22
NetworkInterfaceIdstring

弹性网卡的 ID。

eni-bp125p95hhdhn3ot****
ServiceIDlong

弹性网卡对应的虚商 ID。

12345678910
InstanceIdstring

弹性网卡附加的实例 ID。

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

弹性网卡的所属账号 ID。

123456****
ServiceManagedboolean

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

true
VSwitchIdstring

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

vsw-bp1s5fnvk4gn2tws0****
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
Descriptionstring

弹性网卡描述。

testDescription
ResourceGroupIdstring

实例所属的企业资源组 ID。使用该参数过滤资源时,资源数量不能超过 1000 个。

说明 不支持默认资源组过滤。
rg-bp67acfmxazb4p****
ZoneIdstring

可用区 ID。

cn-hangzhou-g
PrivateIpAddressstring

弹性网卡的私网 IP 地址。

10.1.**.**
QueueNumberinteger

弹性网卡的队列数。

  • 弹性网卡为主网卡:返回实例规格默认的主网卡队列数。

  • 弹性网卡为辅助网卡:

    • 辅助网卡是已附加(InUse)状态:
      • 辅助网卡没有修改过队列数,则返回实例规格默认的辅助网卡队列数。
      • 辅助网卡修改过队列数,则返回修改后的队列数。
    • 辅助网卡是可用(Available)状态:
      • 辅助网卡未修改过队列数,则返回值为空。
      • 辅助网卡修改过队列数,则返回修改后的队列数。
8
SecurityGroupIdsarray

弹性网卡所属的安全组集合。

SecurityGroupIdstring

弹性网卡所属的安全组。

sg-bp18kz60mefsicfg****
AssociatedPublicIpobject

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

PublicIpAddressstring

弹性公网 IP 地址。

116.62.**.**
AllocationIdstring

弹性公网 IP 的 ID。

null
Attachmentobject
说明 该参数正在邀测中,暂未开放使用。
DeviceIndexinteger
说明 该参数正在邀测中,暂未开放使用。
hide
InstanceIdstring
说明 该参数正在邀测中,暂未开放使用。
hide
TrunkNetworkInterfaceIdstring
说明 该参数正在邀测中,暂未开放使用。
hide
MemberNetworkInterfaceIdsarray
说明 该参数正在邀测中,暂未开放使用。
MemberNetworkInterfaceIdstring
说明 该参数正在邀测中,暂未开放使用。
hide
NetworkCardIndexinteger

网卡挂载指定的物理网卡索引。

  • 如果网卡是未挂载(Available)状态或者挂载时未指定索引,则不返回此值。
  • 如果网卡是已挂载(InUse)状态且挂载时指定,此值表示网卡挂载指定的物理网卡索引。
0
PrivateIpSetsarray<object>

PrivateIpSet 组成的集合。

PrivateIpSetobject

PrivateIpSet 组成的集合。

PrivateIpAddressstring

弹性网卡的私网 IP 地址。

172.17.**.**
Primaryboolean

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

  • true:主私网 IP。
  • false:辅助私网 IP。
true
AssociatedPublicIpobject

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

PublicIpAddressstring

弹性公网 IP 地址。

116.62.**.**
AllocationIdstring
说明 该参数正在邀测中,暂未开放使用。
null
Ipv6Setsarray<object>

弹性网卡已分配的 IPv6 地址。

Ipv6Setobject

弹性网卡已分配的 ipv6 地址。

Ipv6Addressstring

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

2001:db8:1234:1a00::****
Ipv4PrefixSetsarray<object>

弹性网卡已分配的 IPv4 前缀集合。

Ipv4PrefixSetobject
Ipv4Prefixstring

弹性网卡已分配的 IPv4 前缀。

192.168.**.0/28
Ipv6PrefixSetsarray<object>

弹性网卡已分配的 IPv6 前缀集合。

Ipv6PrefixSetobject
Ipv6Prefixstring

弹性网卡已分配的 IPv6 前缀。

2001:db8:1234:1a00:****::/80
Tagsarray<object>

弹性网卡的标签集合。

Tagobject

弹性网卡的标签集合。

TagValuestring

标签值。

TestValue
TagKeystring

标签键。

TestKey
BondInterfaceSpecificationobject
说明 该参数正在邀测中,暂未开放使用。
BondModestring
说明 该参数正在邀测中,暂未开放使用。
null
SlaveInterfaceSpecificationarray<object>
说明 该参数正在邀测中,暂未开放使用。
SlaveInterfaceSpecificationSetobject
说明 该参数正在邀测中,暂未开放使用。
SlaveNetworkInterfaceIdstring
说明 该参数正在邀测中,暂未开放使用。
null
WorkStatestring
说明 该参数正在邀测中,暂未开放使用。
null
BondNetworkInterfaceIdstring
说明 该参数正在邀测中,暂未开放使用。
null
SlaveInterfaceSpecificationobject
说明 该参数正在邀测中,暂未开放使用。
SlaveNetworkInterfaceIdstring
说明 该参数正在邀测中,暂未开放使用。
null
WorkStatestring
说明 该参数正在邀测中,暂未开放使用。
null
BondNetworkInterfaceIdstring
说明 该参数正在邀测中,暂未开放使用。
null
DeleteOnReleaseboolean

释放实例时是否保留网卡。可能值:

  • true:不保留。

  • false:保留。

true
TcpOptionAddressEnabledstring
说明 该参数正在邀测中,暂未开放使用。
null
NetworkInterfaceTrafficConfigobject

弹性网卡通讯参数

NetworkInterfaceTrafficModestring

弹性网卡的通讯模式。

HighPerformance
QueueNumberinteger

弹性网卡队列数。

8
QueuePairNumberinteger

RDMA 网卡队列数。

8
ConnectionTrackingConfigurationobject
说明 该参数暂未开放使用。
TcpEstablishedTimeoutinteger
说明 该参数暂未开放使用。
910
TcpClosedAndTimeWaitTimeoutinteger
说明 该参数暂未开放使用。
3
UdpTimeoutinteger
说明 该参数暂未开放使用。
30
SourceDestCheckboolean

该参数暂未开放使用。

false
EnhancedNetworkobject

该参数暂未开放使用。

EnableSriovboolean

该参数暂未开放使用。

false

示例

正常返回示例

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": {
    "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",
  "NetworkInterfaceTrafficConfig": {
    "NetworkInterfaceTrafficMode": "HighPerformance",
    "QueueNumber": 8,
    "QueuePairNumber": 8
  },
  "ConnectionTrackingConfiguration": {
    "TcpEstablishedTimeout": 910,
    "TcpClosedAndTimeWaitTimeout": 3,
    "UdpTimeout": 30
  },
  "SourceDestCheck": false,
  "EnhancedNetwork": {
    "EnableSriov": false
  }
}

错误码

HTTP status code错误码错误信息描述
400MissingParameter%s缺失参数,请检查参数是否完整。
400UnsupportedParameter%s不支持参数。
400InvalidParameter%s无效的参数。
400InvalidInstanceID.Malformed%s参数 InstanceId 格式错误。
400Forbidden.RegionId%s当前地域暂时没有提供该服务。
400InvalidRegionId.MalFormedThe specified parameter RegionId is not valid.指定的 RegionId 不合法。
403InvalidUserType.NotSupported%s您当前的账号不支持此操作。
403Abs.InvalidAccount.NotFound%s您的阿里云账号不存在,或者您的 AccessKey 已经过期。
403Forbidden.NotSupportRAM%s暂不支持RAM用户执行该操作。
403Forbidden.SubUser%s您的账号没有操作此资源的权限,请向主账号申请相关的权限。
404InvalidEniId.NotFound%s指定的弹性网卡 ID 不存在。

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

变更历史

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