ListPools - 查询地址池列表--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

ListPools - 查询地址池列表

最近更新时间：2025.05.30 11:49:18首次发布时间：2023.08.21 14:31:37

获取一个 GTM 实例的地址池列表。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=ListPools&Version=2023-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

除了以下参数，您还需要对请求进行鉴权。

参数	类型	是否必填	示例值	描述
Action	String	是	ListPools	要执行的操作，取值：ListPools。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
GtmId	String	是	f5983a66-2326-44fb-b4cd-9cc592827b6e	GTM 实例的 UUID。您可以通过 ListGtms API 获取 UUID。
PoolId	String	否	7cd0ccd6-eeac-4db8-9076-ca297cf8df75	地址池的 ID。在您通过 CreatePool API 创建地址池时，可以通过返回值获取地址池的 ID。默认为空值，即该参数不作为查询条件。
Name	String	否	pool	地址池的名称。UTF-8 格式。最大长度为 64 个 UTF-8 字符。默认为空值，即该参数不作为查询条件。
Remark	String	否	remark	地址池的备注。默认为空字符串。UTF-8 格式。最大长度为 128 个 UTF-8 字符。默认为空值，即该参数不作为查询条件。
AddrType	String	否	ipv4	地址池中地址的类型。 ipv4：IPv4 地址。 ipv6：IPv6 地址。 host：域名。默认为空值，即该参数不作为查询条件。
Address	String	否	203.0.113.0	地址池中的地址。默认为空值，即该参数不作为查询条件。
SearchMode	String	否	like	查询模式。包括以下模式：（默认）like：模糊查询。 exact：精确查询。
PageNumber	Integer	否	1	页码。默认为 1。页数由获取的地址池总数和 `PageSize` 确定。
PageSize	Integer	否	50	每页包含的地址池的数量。默认为 50。云调度 GTM 会将获取的地址池进行分页显示。页数由获取的地址池总数和 `PageSize` 确定。
SortOrder	String	否	Asc	返回结果的排序方向。 Asc：升序。 Desc（默认）：降序。
SortBy	String	否	Name	对返回结果排序的键值。 Name：按 `Name` 参数的值对返回结果进行排列。 Remark：按 `Remark` 参数的值对返回结果进行排列。 AddrType：按 `AddrType` 参数的值对返回结果进行排列。 UpdateTime（默认）：按地址池的更新时间对返回结果进行排列。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
TotalCount	Integer	10	地址池的总数量。
PageNumber	Integer	1	分页的页码。
PageSize	Integer	10	每个分页的地址池数量。
Data	Array of Object	无	地址池的信息。

请求示例

POST https://open.volcengineapi.com/?Action=ListPools&Version=2023-01-01&GtmId=f5983a66-2326-44fb-b4cd-9cc592827b6e

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240606200532A1B96CC204896B001CE4",
        "Action": "ListPools",
        "Version": "2023-01-01",
        "Service": "GTM",
        "Region": "cn-north-1"
    },
    "Result": {
        "TotalCount": 1,
        "PageNumber": 1,
        "PageSize": 100,
        "Data": [
            {
                "CreateTime": "2024-06-06T11:25:50.051Z",
                "UpdateTime": "2024-06-06T11:25:50.051Z",
                "PoolId": "7cd0ccd6-eeac-4db8-9076-ca297cf8df75",
                "Name": "example",
                "Remark": "",
                "Addresses": [
                    {
                        "Value": "1.**.**.**",
                        "Weight": 1,
                        "Capacity": 1000,
                        "Mode": "auto",
                        "Geo": "大洋洲_澳大利亚"
                    }
                ],
                "AddrType": "ipv4",
                "Capacity": 100,
                "CapacityMode": "address",
                "Deletable": false
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
504	internal error	内部错误	内部错误