DescribeNetworkInterfaces

DescribeNetworkInterfaces

1. API Description

This API is used to query the information of one or more specified vNICs. Users can search for vNIC information based on vNIC ID, vNIC name, etc.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
nicIds	No	Array of String	vNic ID(s).
name	No	String	vNIC name. Fuzzy search supported.
regionId	No	String	Region ID.
vpcId	No	String	ID of VPC.
subnetId	No	String	ID of Subnet.
instanceId	No	Strin	ID of Instance.
status	No	String	vNIC state.
pageSize	No	Integer	Number of items in the current page result. Default value: 20; Maximum value: 1000.
pageNum	No	Integer	Number of pages returned. Default value: 1.
nicType	No	NicType	vNIC type.
resourceGroupId	No	String	Resource Group ID.
tagKeys	No	Array of String	Query using tag keys. A maximum of 20 tag keys can be used.
tags	No	Array of Tag	Query using tags. A maximum of 20 tags can be used.

3. Output Parameters

Parameter Name	Type	Description
requestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.
dataSet	Array of NicInfo	Information on vNIC(s).
totalCount	Integer	Number of vNICs meeting the filtering conditions.

4. Code Example

Example

Query the list of secondary vNICs.

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": "T33CFA599-AD4E-4B7E-9F56-A0D39857E91F",
  "response": {
      "requestId": "T33CFA599-AD4E-4B7E-9F56-A0D39857E91F",
      "totalCount": 1,
      "dataSet": [
          {
              "subnetId": "<subnetId>",
              "resourceGroup": {
                  "resourceGroupName": "Default Resource Group",
                  "resourceGroupId": "<resourceGroupId>"
              },
              "primaryIpv4": "10.130.0.2",
              "privateIpList": ["10.130.0.2","fd9c:d016:1eb2:2:0:2::2"],
              "nicSubnetType": "IPv4_IPv6",
              "updateTime": "2025-07-29T09:59:16Z",
              "primaryIpv6": "fd9c:d016:1eb2:2:0:2::2",
              "publicIpList": ["128.0.0.2","128.0.0.3"],
              "securityGroupId": "<securityGroupId>",
              "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-1",
              "nicId": "1511370676722866275",
              "status": "AVAILABLE",
              "secondaryIpv4s": [],
              "tags":null
          }
      ]
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

No error codes related to the API business logic. For other error codes, see Common Error Codes.