DescribePools

1. 接口描述

本接口用于查询公网IP池列表。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称	必选	类型	描述
poolIds	否	Array of String	根据公网IP池的ID。
regionId	否	String	根据公网IP池的所在节点ID过滤。
name	否	String	根据公网IP池的名称过滤。 支持模糊查询。
pageSize	否	Integer	返回的分页大小，默认为20，最大为1000。 可选值范围：[1, 1000]。
pageNum	否	Integer	返回的分页数，默认为1。 可选值范围：[1, +)。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID。 每次请求都会返回。定位问题时需要提供该次请求的 requestId。
totalCount	Integer	符合条件的数据总数。
dataSet	Array of PoolInfo	公网IP池列表的结果数据。

4. 代码示例

示例

1. 查询公网IP池列表。

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. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码