GetPool-获取地址池信息--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

GetPool-获取地址池信息

最近更新时间：2024.07.30 10:11:27首次发布时间：2023.08.21 14:31:38

获取一个地址池的信息。

请求说明

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

请求参数

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

Query

名称	类型	是否必选	示例值	描述
Action	String	是	`GetPool`	API 的名称。该参数的取值为 `GetPool`。
Version	String	是	`2023-01-01`	API 的版本。该参数的取值是 `2023-01-01`。
GtmId	String	是	`2a8f91c4-aa07-4ae4-9ebc-68750d611822`	GTM 实例的 UUID。您可以通过 ListGtms API 获取 UUID。
PoolId	String	是	`7cd0ccd6-eeac-4db8-9076-ca297cf8df75`	地址池的 ID。您可以通过 CreatePool API或ListPools API 获取地址池的 ID。

返回参数

ResponseMetadata 对象

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

Result 对象

名称	类型	描述
CreateTime	String	地址池的创建时间。精确到毫秒。格式符合 ISO 8601 标准。
UpdateTime	String	地址池最近的更改时间。精确到毫秒。格式符合 ISO 8601 标准。
PoolId	String	地址池的 ID。
Name	String	地址池的名称。
Remark	String	地址池的备注。
Addresses	Array of Objects	地址池中的地址。
AddrType	String	地址池中地址的类型。 ip4：IPv4 地址。 ip6：IPv6 地址。 host：域名，例如 www.example.com。
Capacity	Integer	地址池的容量。如果地址池中的地址未设置容量，该参数会返回默认容量值 1000。
CapacityMode	String	在容量优先或负载反馈路由模式下，选择配置地址池或目标地址的容量。 address：配置目标地址的容量。选择 address 后，您只能设置每个目标地址的 Capacity 参数。地址池 Capacity 参数的值由目标地址 Capacity 的值自动相加得出，您无法修改。在负载反馈路由模式下，您也只能上报目标地址的容量和负载。 pool：配置地址池的容量。选择 pool 后，您只能设置地址池的 Capacity 参数。每个目标地址的 Capacity 参数的值由地址池的 Capacity 参数的值自动平均分配。您无法修改。在负载反馈路由模式下，您也只能上报地址池的容量和负载。
Deletable	Boolean	该地址池是否可以被删除。 true：该地址池没有被路由规则引用，可以被删除。 false：该地址池被一个或多个路由规则引用，不可以被删除。

示例

请求示例

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": "2024060620113734D1D01CDFC1B6003159",
        "Action": "GetPool",
        "Version": "2023-01-01",
        "Service": "GTM",
        "Region": "cn-north-1"
    },
    "Result": {
        "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
    }
}

错误码

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