# 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.

<table><thead><tr><th width="166.71563720703125">Parameter Name</th><th width="109.360107421875">Required</th><th width="89.3311767578125">Type</th><th>Description</th></tr></thead><tbody><tr><td>nicIds</td><td>No</td><td>Array of String</td><td>vNic ID(s).</td></tr><tr><td>name</td><td>No</td><td>String</td><td>vNIC name.<br>Fuzzy search supported.</td></tr><tr><td>regionId</td><td>No</td><td>String</td><td>Region ID.</td></tr><tr><td>vpcId</td><td>No</td><td>String</td><td>ID of VPC.</td></tr><tr><td>subnetId</td><td>No</td><td>String</td><td>ID of Subnet.</td></tr><tr><td>instanceId</td><td>No</td><td>Strin</td><td>ID of Instance.</td></tr><tr><td>status</td><td>No</td><td>String</td><td><a href="../../datastructure#nicstatus">vNIC state.</a></td></tr><tr><td>pageSize</td><td>No</td><td>Integer</td><td><p>Number of items in the current page result.</p><p>Default value: <code>20</code>;<br>Maximum value: <code>1000</code>.</p></td></tr><tr><td>pageNum</td><td>No</td><td>Integer</td><td><p>Number of pages returned.</p><p>Default value: <code>1</code>.</p></td></tr><tr><td>nicType</td><td>No</td><td><a href="../../datastructure#nictype">NicType</a></td><td>vNIC type.</td></tr><tr><td>resourceGroupId</td><td>No</td><td>String</td><td>Resource Group ID.</td></tr><tr><td>tagKeys</td><td>No</td><td>Array of String</td><td><p>Query using tag keys.</p><p>A maximum of 20 tag keys can be used.</p></td></tr><tr><td>tags</td><td>No</td><td>Array of <a href="../../datastructure#tag">Tag</a></td><td><p>Query using tags.</p><p>A maximum of 20 tags can be used.</p></td></tr></tbody></table>

## 3. Output Parameters

<table><thead><tr><th width="160.84686279296875">Parameter Name</th><th width="149.5062255859375">Type</th><th>Description</th></tr></thead><tbody><tr><td>requestId</td><td>String</td><td>The unique request ID, which is returned for each request. RequestId is required for locating a problem.</td></tr><tr><td>dataSet</td><td>Array of <a href="../../datastructure#nicinfo">NicInfo</a></td><td>Information on vNIC(s).</td></tr><tr><td>totalCount</td><td>Integer</td><td>Number of vNICs meeting the filtering conditions.</td></tr></tbody></table>

## 4. Code Example

{% tabs %}
{% tab title="Example" %}
**Query the list of secondary vNICs.**

```json
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
          }
      ]
  }
}
```

{% endtab %}
{% endtabs %}

## 5. Developer Resources

Zenlayer Cloud API 2.0 integrates [SDKs](https://docs.console.zenlayer.com/test/ci-develop-en/api-introduction/software-toolkit/sdk/introduction) 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](https://docs.console.zenlayer.com/test/ci-develop-en/api-introduction/instruction/commonerrorcode).

123
