DescribeCidrs

1. API Description

This API (DescribeCidrs) 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.

Note

• usedCount is deprecated (always empty). Use availableCount to determine how many IP addresses are currently available in this CIDR.

• availableCount = totalCount − the number of addresses actually in use (for a block-type (Block) EIP, all addresses covered by its prefix length are counted, without excluding .0/.255).

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
cidrIds	No	Array of String	Filter by one or more CIDR block IDs.
regionId	No	String	Filter by the region ID of the CIDR block.
name	No	String	CIDR block name. Fuzzy search supported.
cidrBlock	No	String	CIDR IP range. Fuzzy search supported.
source	No	CidrCreateSource	IP type. IP leasing or BYOIP.
asn	No	Integer	Filter by ASN.
resourceGroupId	No	String	Resource Group ID.
pageSize	No	Integer	Number of items in the current page result. Default value: 20; Value range: [1, 1000]
pageNum	No	Integer	Number of pages returned. Default value: 1. Value range: [1, +) Default value: 1
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.
totalCount	Integer	Number of CIDR blocks meeting the filtering conditions.
dataSet	Array of CidrInfo	Information on CIDR blocks.

4. Code Example

Example

1. Query the list of CIDR blocks with CidrBlock 128.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：
{
  "regionId": "asia-east-1",
  "cidrBlock": "128.0.0.0/24",
  "pageSize": 10,
  "pageNum": 1
}
Response：
{
    "requestId": "TA87CE637-EDF9-423A-81C0-5A6605789BBE",
    "response": {
        "dataSet": [
            {
                "cidrBlock": "128.0.0.0/24",
                "cidrId": "<cidrId>",
                "createTime": "2026-04-28T09:22:44Z",
                "eipV4Type": "BGPLine",
                "name": "128.0.0.0/24",
                "netmask": 24,
                "networkLineType": "PremiumBGP",
                "poolId": "<poolId>",
                "regionId": "<regionId>",
                "resourceGroupId": "<resourceGroupId>",
                "resourceGroupName": "<resourceGroupName>",
                "source": "CONSOLE",
                "status": "AVAILABLE",
                "asn": 12345,
                "totalCount": 20,
                "usedCount": null,
                "availableCount": 19,
                "availableCidr": [
                    {"prefixLength": 25, "count": 1},
                    {"prefixLength": 26, "count": 2},
                    {"prefixLength": 27, "count": 4}
                ],
                "asnObservation": {
                    "verificationStatus": "agreed",
                    "observedPrefix": "128.0.0.0/24",
                    "primarySource": "RIPE",
                    "primaryStatus": "FINISHED",
                    "primaryAsns": [12345],
                    "secondarySource": "BGP Tool",
                    "secondaryStatus": "FINISHED",
                    "secondaryAsns": [12345]
                }
            }
        ],
        "requestId": "TA87CE637-EDF9-423A-81C0-5A6605789BBE",
        "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

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

HTTP Status Code	Error Code	Description