最近更新时间:2024.03.22 17:18:04
首次发布时间:2023.08.21 14:31:38
API 名称:GetPool
。
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。 |
参数名称 | 数据类型 | 参数说明 |
---|---|---|
RequestId | String | 标识本次请求的 ID。 |
Action | String | Action 查询参数的值。 |
Version | String | API 版本。 |
Service | String | 服务类型。 |
Region | String | 服务所在区域。 |
参数名称 | 数据类型 | 参数说明 |
---|---|---|
CreateTime | String | 地址池的创建时间。精确到毫秒。格式符合 ISO 8601 标准。 |
UpdateTime | String | 地址池最近的更改时间。精确到毫秒。格式符合 ISO 8601 标准。 |
PoolId | String | 地址池的 ID。 |
Name | String | 地址池的名称。 |
Remark | String | 地址池的备注。 |
Addresses | Array of Objects | 地址池中的地址。 |
AddrType | String | 地址池中地址的类型。
|
Capacity | Integer | 地址池的容量。如果地址池中的地址未设置容量,该参数会返回默认容量值 0。 |
Deletable | Boolean | 该地址池是否可以被删除。
|
POST https://open.volcengineapi.com/?Action=GetPool&Version=2023-01-01&GtmId=2a8f91c4-aa07-4ae4-9ebc-68750d611822&PoolId=cf65f46e-6a19-4d15-99b5-684a6ce4e7ff
{ "ResponseMetadata": { "RequestId": "202307271549006A6FACAA0F635F686990", "Action": "GetPool", "Version": "2023-01-01", "Service": "GTM", "Region": "cn-north-1" }, "Result": { "CreateTime": "2023-07-27T07:23:18.833Z", "UpdateTime": "2023-07-27T07:23:18.833Z", "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 } }