You need to enable JavaScript to run this app.
导航
获取地址池列表
最近更新时间:2024.06.14 16:35:05首次发布时间:2023.08.21 14:31:37

API 说明

API 名称:ListPools
API 域名:open.volcengineapi.com
API 描述:获取地址池信息列表。

请求方法

POST

请求参数

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

参数名称数据类型参数类型是否必选参数说明

Action

String

查询参数

API 的名称。该参数的取值为 ListPools

Version

String

查询参数

API 的版本。该参数的取值是 2023-01-01

GtmId

String

查询参数

GTM 实例的 UUID。您可以通过 ListGtms API 获取 UUID。

PoolId

String

查询参数

地址池的 ID。在您通过 CreatePool API 创建地址池时,可以通过返回值获取地址池的 ID。默认为空值,即该参数不作为查询条件。

Name

String

查询参数

地址池的名称。UTF-8 格式。最大长度为 64 个 UTF-8 字符。默认为空值,即该参数不作为查询条件。

Remark

String

查询参数

地址池的备注。默认为空字符串。UTF-8 格式。最大长度为 128 个 UTF-8 字符。默认为空值,即该参数不作为查询条件。

AddrType

String

查询参数

地址池中地址的类型。

  • ipv4:IPv4 地址。
  • ipv6:IPv6 地址。
  • host:域名,例如 www.example.com。

默认为空值,即该参数不作为查询条件。

AddressString查询参数地址池中的地址。默认为空值,即该参数不作为查询条件。

SearchMode

String

查询参数

查询模式。包括以下模式:

  • (默认)like:模糊查询。
  • exact:精确查询。

SortBy

String

查询参数

对返回结果排序的键值。

  • Name:按 Name 参数的值对返回结果进行排列。
  • Remark:按 Remark 参数的值对返回结果进行排列。
  • AddrType:按 AddrType 参数的值对返回结果进行排列。
  • UpdateTime:按地址池的更新时间对返回结果进行排列。

默认为空值。返回结果会根据地址池的更新时间降序排列。

SortOrder

String

查询参数

返回结果的排序方向。
默认为空值。默认的排序方向为:

  • Name:按 Name 参数的值对返回结果进行升序排列。
  • Remark:按 Remark 参数的值对返回结果进行升序排列。
  • AddrType:按 AddrType 参数的值对返回结果进行升序排列。
  • UpdateTime:按地址池的更新时间对返回结果按时间降序排列。

如果你不设置 SortBy,则该参数无效。

PageSize

Integer

查询参数

每页包含的地址池的数量。默认为 50。
控制台会将获取的地址池进行分页显示。页数由获取的地址池总数和 PageSize 确定。

PageNumberInteger查询参数页码。默认为 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": "x.x.x.x",
                        "Weight": 1,
                        "Capacity": 1000,
                        "Mode": "auto",
                        "Geo": "大洋洲_澳大利亚"
                    }
                ],
                "AddrType": "ipv4",
                "Capacity": 100,
                "CapacityMode": "address",
                "Deletable": false
            }
        ]
    }
}