Doc CenterSign in to zenConsole

DescribeCidrUsedIps

1. API Description

This API is used to query the list of used CIDR IPs.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name
Required
Type
Description

cidrId

Yes

String

CIDR ID.

publicIp

No

String

CIDR IP address.

instanceId

No

String

Instance ID.

instanceName

No

String

Instance name.

nicId

No

String

vNIC ID.

nicName

No

String

vNIC name.

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

Information on private IP.

totalCount

Integer

Number of CIDR IPs meeting the filtering conditions.

4. Code Example

Query the list of used CIDR IPs.

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

Request:
{
  "cidrId": "xxx",
  "publicIp": "xxx",
  "instanceId": "xxx",
  "instanceName": "xxx",
  "nicId": "xxx",
  "nicName": "xxx",
  "pageSize": 10,
  "pageNum": 1
}

Response:
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
    "totalCount": 10,
    "dataSet": [
      {
        "publicIp": "xxx",
        "lanIp": "xxx",
        "nicId": "xxx",
        "nicName": "xxx",
        "instanceId": "xxx",
        "instanceName": "xxx"
      }
    ]
  }
}

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

Last updated