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.

status

No

String

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.

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

Query the list of vNICs.

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

123

Last updated