# DescribePools

## 1. API Description

This API (DescribePools) is used to query the information of one or more IP pools. Users can search for IP pool information based on pool ID, pool name, etc.

## 2. Input Parameters

The following request parameter list only provides API request parameters.

| Parameter Name | Required | Type            | Description                                                                                               |
| -------------- | -------- | --------------- | --------------------------------------------------------------------------------------------------------- |
| poolIds        | No       | Array of String | Pool ID(s).                                                                                               |
| regionId       | No       | String          | Region ID.                                                                                                |
| name           | No       | String          | <p>Pool name.</p><p>Fuzzy search supported.</p>                                                           |
| 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>Value range: \[1, +)</p><p>Default value: 1</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 pools meeting the filtering conditions.                                                                     |
| dataSet        | Array of [PoolInfo](https://docs.console.zenlayer.com/api-reference/compute/datastructure#poolinfo) | Information on pools.                                                                                                 |

## 4. Code Example

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

<pre class="language-json"><code class="lang-json"><strong>POST /api/v2/zec HTTP/1.1
</strong>Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribePools


Request:
{
  "poolIds": ["xxx"],
  "regionId": "asia-east-1"
  "pageSize": 10,
  "pageNum": 1
}

Response:
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
    "totalCount": 10,
    "dataSet": [
      {
        "poolId": "xxx",
        "regionId": "xxx",
        "name": "xxx",
        "createTime": "xxx",
      }
    ]
  }
}
</code></pre>

{% 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 |
| ---------------- | ---------- | ----------- |