DescribeNetworkInterfaces

1. 接口描述

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

2. 请求参数

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

参数名称	必选	类型	描述
nicIds	否	Array of String	根据网卡ID过滤。 最多传入100个ID。
name	否	String	根据网卡所属的名称过滤。 该字段支持模糊搜索。
regionId	否	String	根据网卡所属的节点 ID过滤。
vpcId	否	String	根据网卡所属的VPC ID过滤。
subnetId	否	String	根据网卡所属的子网ID过滤。
instanceId	否	String	网卡关联的实例ID过滤。
status	否	NicStatus	根据网卡的状态过滤。
pageSize	否	Integer	返回的分页大小。 可选值范围：[1, 1000]。
pageNum	否	Integer	返回的分页数。 可选值范围：[1, +)。
nicType	否	NicType	根据网卡的类型筛选过滤。
resourceGroupId	否	String	根据网卡所属的资源组ID过滤。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID。 每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
totalCount	Integer	符合条件的数据总数。
dataSet	Array of NicInfo	网卡的结果集。

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：
{
  "nicType": "Secondary",
  "pageSize": 1,
  "pageNum": 1
}

Response：
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
    "dataSet": [
      {
        "subnetId": "<subnetId>",
        "resourceGroup": {
          "resourceGroupName": "Default Resource Group",
          "resourceGroupId": "<resourceGroupId>"
        },
        "primaryIpv4": "10.0.0.2",
        "privateIpList": [
          "10.0.0.2",
          "10.0.0.4",
          "fd9c:d016:1eb2:2:0:2::2"
        ],
        "nicSubnetType": "IPv4_IPv6",
        "primaryIpv6": "fd9c:d016:1eb2:2:0:2::2",
        "publicIpList": ["128.0.0.2","128.0.0.3"],
        "ipv6Cidr": "fd9c:d016:1eb2:2:0:2::/96",
        "macAddress": "52:54:xx:xx:xx:10",
        "instanceId": null,
        "regionId": "asia-east-1",
        "createTime": "2025-07-29T09:59:16Z",
        "nicType": "Secondary",
        "vpcId": "<vpcId>",
        "name": "Elastic-NIC-asia-east-1",
        "nicId": "<nicId>",
        "status": "AVAILABLE",
        "secondaryIpv4s": ["10.0.0.4"]
      }
    ],
    "totalCount": 3
  }
}

5. 开发者工具

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

6. 错误码

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