DescribePools

1. API Description

This API 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	Pool name. Fuzzy search supported.
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 PoolInfo	Information on pools.
totalCount	Integer	Number of pools meeting the filtering conditions.

4. Code Example

Example

Query pool 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: DescribePools
<Common Request Params>

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",
      }
    ]
  }
}

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