Doc CenterSign in to zenConsole

DescribeCidrs

1. API Description

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

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name
Required
Type
Description

cidrIds

No

Array of String

CIDR block ID(s).

regionId

No

String

Region ID.

name

No

String

CIDR block name. Fuzzy search supported.

cidrBlock

No

String

CIDR IP range. Fuzzy search supported.

source

No

String

IP type. IP leasing or BYOIP.

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 CidrInfo

Information on CIDR blocks.

totalCount

Integer

Number of CIDR blocks meeting the filtering conditions.

4. Code Example

Query CIDR block list with IP range of 10.0.0.0/24.

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

Request:
{
  "cidrIds": ["xxx"],
  "regionId": "asia-east-1"
  "cidrBlock": "10.0.0.0/24",
  "pageSize": 10,
  "pageNum": 1
}

Response:
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
    "totalCount": 10,
    "dataSet": [
      {
        "cidrId": "xxx",
        "regionId": "xxx",
        "name": "xxx",
        "cidrBLock": "10.0.0.0/24",
        "totalCount"：20,
        "usedCount": 1,
        "source": "CONSOLE",
        "networkType": "BGP_LINE",
        "netmask": 2,
        "createTime": "xxx",
        "expiredTime": "xxx",
        "period": 1,
        "instanceChargeType": "POSTPAID",
        "resourceGroupId": "xxx",
        "resourceGroupName": "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