You need to enable JavaScript to run this app.
导航
TrafficRoute DNS 套件
  • 文档首页
    • /TrafficRoute DNS 套件/云调度 GTM/API 参考/地址池管理接口/ListPools-获取地址池列表
ListPools-获取地址池列表
最近更新时间：2024.07.30 10:11:17首次发布时间：2023.08.21 14:31:37
我的收藏

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

请求说明

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

请求参数

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

Query

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

响应正文

ResponseMetadata 对象

名称
类型
描述
RequestId
String
标识本次请求的 ID。
Action
String
Action 查询参数的值。
Version
String
API 版本。
Service
String
服务类型。
Region
String
服务所在区域。

Result 对象

名称
类型
描述
TotalCount
Integer
地址池的总数量。
PageNumber
Integer
分页的页码。
PageSize
Integer
每个分页的地址池数量。
Data
Array of Objects
地址池的信息。

示例

请求示例

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

错误码

您可访问公共错误码，获取详细信息。