> For the complete documentation index, see [llms.txt](https://docs.console.zenlayer.com/api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.console.zenlayer.com/api-reference/compute/bmc/cidr-block/describecidrblocks.md).
# DescribeCidrBlocks
## 1. API Description
This API (DescribeCidrBlocks) is used to query the details of CIDR blocks.
## 2. Input Parameters
The following request parameter list only provides API request parameters.
| Parameter Name | Required | Type | Description |
| --------------- | -------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| cidrBlockIds | No | Array of String | IDs of the CIDR blocks.
You can query up to 100 CIDR blocks in each request.
|
| cidrBlock | No | String | IP range of CIDR block. |
| cidrBlockName | No | String | Name of CIDR block. |
| zoneId | No | String | Zone ID to which the CIDR blocks belong. |
| cidrBlockType | No | [IpType](/api-reference/compute/bmc/datastructure.md#iptype) | Type of CIDR block. The optional values are as follows:
IPv4 IPv6
|
| gateway | No | String | IP address of the gateway. |
| chargeType | No | [ChargeType](/api-reference/compute/bmc/datastructure.md#chargetype) | CIDR block pricing model .
PREPAID: subscription POSTPAID: pay-as-you-go
|
| resourceGroupId | No | String | Resource group ID.
If the value is null, then return all the CIDR blocks in the authorized resource groups.
|
| pageNum | No | Integer | Number of pages returned.
Default value: 1.
Default value: 1
|
| pageSize | No | Integer | Number of items in the current page result.
Default value: 20;
Maximum value: 1000.
|
| tagKeys | No | Array of String | Query according to tag key.
You can query up to 20 tag keys in each request.
|
| tags | No | Array of [Tag](/api-reference/compute/bmc/datastructure.md#tag) | Query according to tag.
You can query up to 20 tags in each request.
|
## 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 [CidrBlockInfo](/api-reference/compute/bmc/datastructure.md#cidrblockinfo) | Information on a CIDR block. |
## 4. Code Example
{% tabs %}
{% tab title="Example" %}
```json
POST /api/v2/bmc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeCidrBlocks
Request:
{
"pageNum": 1,
"pageSize": 1
}
Response:
{
"requestId": "T9731D74B-4EA3-498E-AC75-4C036ABAF598",
"response": {
"requestId": "T9731D74B-4EA3-498E-AC75-4C036ABAF598",
"totalCount": 14,
"dataSet": [
{
"cidrBlockId": "767715590704998412",
"cidrBlockType": "IPV4",
"cidrBlockName": "mycidrblock",
"zoneId": "CHI-A",
"cidrBlock": "1.1.218.184/29",
"gateway": "1.1.218.185",
"availableIpStart": "1.1.218.186",
"availableIpEnd": "1.1.218.190",
"availableIpCount": 5,
"instanceIds": [
"780812773306141196"
],
"status": "RECYCLE",
"chargeType": "POSTPAID",
"createTime": "2022-11-25T05:53:50Z",
"expireTime": "2022-11-25T08:00:42Z",
"resourceGroupId": "5eab5afc-88a2-46a9-bad3-278df7069f13",
"resourceGroupName": "Default Resource Group"
}
]
}
}
```
{% endtab %}
{% endtabs %}
## 5. Developer Resources
Zenlayer Cloud API 2.0 integrates [SDKs](/api-reference/api-introduction/toolkit/api-sdk.md)，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](/api-reference/api-introduction/instruction/commonerrorcode.md).
| HTTP Status Code | Error Code | Description |
| ---------------- | ------------------------- | --------------- |
| 404 | INVALID\_ZONE\_NOT\_FOUND | Zone not found. |
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.console.zenlayer.com/api-reference/compute/bmc/cidr-block/describecidrblocks.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.