DescribeNetworkInterfaces

1. 接口描述

本接口用于查询一台或多台指定网卡的信息。用户可以根据网卡 ID、网卡名称等信息来搜索网卡信息

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称

必选

类型

描述

nicIds

否

Array of String

一个或多个待操作的Nic ID

name

否

String

网卡名称支持模糊查询

regionId

否

String

区域ID

vpcId

否

String

VPC的ID

subnetId

否

String

Subnet的ID

instanceId

否

String

根据网卡关联的实例ID过滤。

status

否

String

网卡状态

pageSize

否

Integer

返回的分页大小。

默认为20，最大为1000

pageNum

否

Integer

返回的分页数。

默认为1

3. 响应结果

参数名称

类型

描述

requestId

String

唯一请求 ID。

每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

dataSet

Array of NicInfo

NicInfo的结果集

totalCount

Integer

符合条件的数据总数

4. 代码示例

1. 分页查询网卡列表

POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeNetworkInterfaces
<Common Request Params>

Request:
{
  "name": "xxx",
  "regionId": "xxx",
  "pageSize": 10,
  "pageNum": 1
}

Response:
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
    "dataSet": [
      {
        "nicId": "xxx",
        "name": "xxx",
        "status": "AVAILABLE",
        "nicType": "Primary",
        "regionId": "xxx",
        "nicSubnetType": "IPv4",
        "publicIpList": ["a","b","c"],
        "privateIpList": ["d","e","f"],
        "instanceId": "xxx",
        "vpcId": "xxx",
        "subnetId": "xxx",
        "createTime": "xxx"
      }
    ],
    "totalCount": 1
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

最后更新于21天前