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

## 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                                                                                                     | <p>CIDR block name.</p><p>Fuzzy search supported.</p>                                                      |
| cidrBlock       | No       | String                                                                                                     | <p>CIDR IP range.</p><p>Fuzzy search supported.</p>                                                        |
| source          | No       | [CidrCreateSource](https://docs.console.zenlayer.com/api-reference/compute/datastructure#cidrcreatesource) | IP type. IP leasing or BYOIP.                                                                              |
| resourceGroupId | No       | String                                                                                                     | Resource Group ID.                                                                                         |
| pageSize        | No       | Integer                                                                                                    | <p>Number of items in the current page result.</p><p>Default value: 20;</p><p>Value range: \[1, 1000]</p>  |
| pageNum         | No       | Integer                                                                                                    | <p>Number of pages returned.</p><p>Default value: 1.</p><p>Value range: \[1, +)</p><p>Default value: 1</p> |
| tagKeys         | No       | Array of String                                                                                            | <p>Query using tag keys.</p><p>A maximum of 20 tag keys can be used.</p>                                   |
| tags            | No       | Array of [Tag](https://docs.console.zenlayer.com/api-reference/compute/datastructure#tag)                  | <p>Query using tags.</p><p>A maximum of 20 tags can be used.</p>                                           |

## 3. Output Parameters

| Parameter Name | Type                                                                                                | Description                                                                                                           |
| -------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| requestId      | String                                                                                              | <p>The unique request ID, which is returned for each request.</p><p>RequestId is required for locating a problem.</p> |
| totalCount     | Integer                                                                                             | Number of CIDR blocks meeting the filtering conditions.                                                               |
| dataSet        | Array of [CidrInfo](https://docs.console.zenlayer.com/api-reference/compute/datastructure#cidrinfo) | Information on CIDR blocks.                                                                                           |

## 4. Code Example

{% tabs %}
{% tab title="Example" %}
**Query CIDR block list with IP range of `10.0.0.0/24`.**

```json
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": "128.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": "128.0.0.0/24",
        "totalCount"：20,
        "usedCount": 1,
        "source": "CONSOLE",
        "eipV4Type": "BGPLine",
        "netmask": 2,
        "poolId": "xxx",
        "createTime": "xxx",
        "expiredTime": "xxx",
        "resourceGroupId": "xxx",
        "resourceGroupName": "xxx",
        "tags":null
      }
    ]
  }
}
```

{% endtab %}
{% endtabs %}

## 5. Developer Resources

Zenlayer Cloud API 2.0 integrates [SDKs](https://docs.console.zenlayer.com/api-reference/api-introduction/toolkit/api-sdk)，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](https://docs.console.zenlayer.com/api-reference/api-introduction/instruction/commonerrorcode).

| HTTP Status Code | Error Code | Description |
| ---------------- | ---------- | ----------- |