最近更新时间:2024.03.22 17:18:04
首次发布时间:2023.08.21 14:31:37
API 名称:ListPools
。
API 域名:open.volcengineapi.com
。
API 描述:获取地址池信息列表。
POST
除了以下参数,您还需要 对请求进行鉴权。
参数名称 | 数据类型 | 参数类型 | 是否必选 | 参数说明 |
---|---|---|---|---|
Action | String | 查询参数 | 是 | API 的名称。该参数的取值为 |
Version | String | 查询参数 | 是 | API 的版本。该参数的取值是 |
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 | 查询参数 | 否 | 地址池中地址的类型。
默认为空值,即该参数不作为查询条件。 |
Address | String | 查询参数 | 否 | 地址池中的地址。默认为空值,即该参数不作为查询条件。 |
SearchMode | String | 查询参数 | 否 | 查询模式。包括以下模式:
|
SortBy | String | 查询参数 | 否 | 对返回结果排序的键值。
默认为空值。返回结果会根据地址池的更新时间降序排列。 |
SortOrder | String | 查询参数 | 否 | 返回结果的排序方向。
如果你不设置 |
PageSize | Integer | 查询参数 | 否 | 每页包含的地址池的数量。默认为 50。 |
PageNumber | Integer | 查询参数 | 否 | 页码。默认为 1。页数由获取的地址池总数和 PageSize 确定。 |
参数名称 | 数据类型 | 参数说明 |
---|---|---|
RequestId | String | 标识本次请求的 ID。 |
Action | String | Action 查询参数的值。 |
Version | String | API 版本。 |
Service | String | 服务类型。 |
Region | String | 服务所在区域。 |
参数名称 | 数据类型 | 参数说明 |
---|---|---|
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": "202308011045371A8015D58B3908F63F3A", "Action": "ListPools", "Version": "2023-01-01", "Service": "GTM", "Region": "cn-north-1" }, "Result": { "TotalCount": 1, "PageNumber": 1, "PageSize": 100, "Data": [ { "CreateTime": "2023-07-27T07:23:18.833Z", "UpdateTime": "2023-07-27T08:04:17.772Z", "PoolId": "cf65f46e-6a19-4d15-99b5-684a6ce4e7ff", "Name": "example-pool", "Remark": "", "Addresses": [ { "Value": "1.1.1.1", "Weight": 1, "Capacity": 1000, "RectifiedGeos": [ "mobile" ], "Mode": "auto", "Geo": "大洋洲_澳大利亚" } ], "AddrType": "ip4", "Capacity": 0, "Deletable": false } ] } }