文档

DescribeNetworkInterfaces - 查看网卡列表

更新时间:

调用DescribeNetworkInterfaces查看网卡列表。

调试

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

授权信息

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

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

请求参数

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

弹性网卡 ID。

eni-58z57orgmt6d1****
InstanceIdstring

实例 ID。

i-5t7z99n32gplriv
NetworkIdstring

网络 ID。

n-2zeuphj08tt7q3brd****
VSwitchIdstring

交换机 ID。

vsw-12345
EnsRegionIdstring

实例所属地域 ID。

cn-tianjin-cmcc
SecurityGroupIdstring

辅助网卡对应的安全组 ID。 如果您需要通过安全组 ID 查询辅助网卡的信息,请指定该参数。

sg-5p1fg655nh68xyz9i***
PrimaryIpAddressstring

弹性网卡主 IP 地址。

10.XXX.XXX.5
Typestring

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

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

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

Secondary
NetworkInterfaceNamestring

弹性网卡的名称。

test-01
Statusstring

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

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

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

Available
PageNumberstring

实例状态列表的页码,起始值为 1。 默认值:1。

1
PageSizestring

分页查询时每页的行数,最大值为 100,默认值为 50。

50

返回参数

名称类型描述示例值
object

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

NetworkInterfaceSetsobject []

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

CreationTimestring

创建时间。按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为:yyyy-MM-ddThh:mmZ。

2022-02-22T03:53:25Z
EnsRegionIdstring

ENS 的节点 ID。

id-jakarta-1
InstanceIdstring

弹性网卡绑定的实例 ID。

i-5siavnr3
MacAddressstring

弹性网卡的 MAC 地址。

00:16:XXX:XXX:60:0a
NetworkInterfaceIdstring

弹性网卡 ID。

eni-uf686a5
PrimaryIpstring

主私网 IP。

10.XXX.XXX.25
PrimaryIpTypestring

主 IP 地址类型。取值:

  • Public:公网地址
  • Private:私网地址
Private
Statusstring

网卡的状态,取值:

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

网络 ID。

n-5w0qd03adw****
VSwitchIdstring

交换机 ID。

vsw-5rqswx1trlsj9
PrivateIpSetsobject []

PrivateIpSet 组成的集合。

PrivateIpAddressstring

私网 IP。

192.XXX.XXX.130
Primaryboolean

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

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

弹性网卡的名称。

primaryTest
Descriptionstring

弹性网卡的描述。

test-description
SecurityGroupIdsarray

安全组 ID。

string

安全组 ID。

sg-5p1bozeiw711a1***
Typestring

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

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

实例状态列表的页码,起始值为:1,默认值:1

1
PageSizeinteger

分页查询时每页的行数,最大值为 50,默认值为 10

50
TotalCountinteger

列表数据总数。

49
RequestIdstring

请求 ID。

708AF9CE-FF92-5DF9-93F8-B7754AB1061A

示例

正常返回示例

JSON格式

{
  "NetworkInterfaceSets": {
    "NetworkInterfaceSet": [
      {
        "CreationTime": "2022-02-22T03:53:25Z",
        "EnsRegionId": "id-jakarta-1",
        "InstanceId": "i-5siavnr3",
        "MacAddress": "00:16:XXX:XXX:60:0a",
        "NetworkInterfaceId": "eni-uf686a5",
        "PrimaryIp": "10.XXX.XXX.25",
        "PrimaryIpType": "Private",
        "Status": "InUse",
        "NetworkId": "n-5w0qd03adw****",
        "VSwitchId": "vsw-5rqswx1trlsj9",
        "PrivateIpSets": {
          "PrivateIpSet": [
            {
              "PrivateIpAddress": "192.XXX.XXX.130",
              "Primary": true
            }
          ]
        },
        "NetworkInterfaceName": "primaryTest",
        "Description": "test-description",
        "SecurityGroupIds": {
          "SecurityGroup": [
            "sg-5p1bozeiw711a1***"
          ]
        },
        "Type": "Primary"
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 50,
  "TotalCount": 49,
  "RequestId": "708AF9CE-FF92-5DF9-93F8-B7754AB1061A"
}

错误码

HTTP status code错误码错误信息描述
400ens.interface.errorAn error occurred while calling the API.-
400Missing%sYou must specify the parameter %s.参数为必填
400Invalid%sThe specified parameter %s is invalid.参数不正确
400NoPermissionPermission denied.没有足够的权限,请联系云账号管理员授予您相应权限。
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

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

变更历史

变更时间变更内容概要操作
2023-10-19OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2023-09-21OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 弃用说明(deprecated)OpenAPI 去除了 deprecated 标记
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:NetworkInterfaceId
    新增入参:NetworkId
    新增入参:SecurityGroupId
    新增入参:Type
    新增入参:NetworkInterfaceName
    新增入参:Status
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)