为一个 GTM 实例创建一个地址池。

请求说明

请求方式：POST

请求地址：https://gtm.volcengineapi.com/?Action=CreatePool&Version=2023-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Action string 必选示例值：CreatePool

要执行的操作，取值：CreatePool。

Version string 必选示例值：2023-01-01

API的版本，取值：2023-01-01。

GtmId string 必选示例值：2a8f91c4-aa07-4ae4-9ebc-68750d611822

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

Pool object 必选示例值：Pool

地址池的名称。UTF-8 格式。最大长度为 64 个 UTF-8 字符。

Name string 必选示例值：pool

地址池的名称。UTF-8 格式。最大长度为 64 个 UTF-8 字符。

Remark string 可选示例值：remark

地址池的备注。UTF-8 格式。最大长度为 128 个 UTF-8 字符。默认为空字符串。

AddrType string 可选示例值：ipv4

地址池的目标地址类型。如果您不设置该参数，云调度 GTM 会自动判断地址池的目标地址类型。

ipv4：IPv4 地址。

ipv6：IPv6 地址。

host：域名。

CapacityMode string 可选示例值：address

在容量优先或负载反馈路由模式下，选择配置地址池或目标地址的容量。

address：（默认）配置目标地址的容量。选择 address 后，您只能设置每个目标地址的 Capacity 参数。地址池 Capacity 参数的值由目标地址 Capacity 的值自动相加得出，您无法修改。在负载反馈路由模式下，您也只能上报目标地址的容量。

pool：配置地址池的容量。选择 pool 后，您只能设置地址池的 Capacity 参数。每个目标地址的 Capacity 参数的值由地址池的 Capacity 参数的值自动平均分配。您无法修改。在负载反馈路由模式下，您也只能上报地址池的容量。

Capacity integer 可选示例值：1000

地址池的容量。默认为 1000。取值范围是 [1,100000]。只有 GTM 实例的策略是智能路由，且路由策略是容量优先时，该参数才有效。

Addresses object[] 必选示例值：无

地址池中的地址。

Value string 必选示例值：203.0.113.0

目标地址。

Weight integer 可选示例值：1

地址的权重。默认为 1。取值范围参见功能版本规格。只有 GTM 实例的策略是基础路由，且开启了负载均衡时，该参数才有效。

Capacity integer 可选示例值：1000

地址的容量。默认为 1000。取值范围是 [1,100000]。

Mode string 可选示例值：auto

目标地址是否可用的判断机制。

auto：（默认）自动模式。云调度 GTM 根据健康检查结果判断地址是否可用。

always_on：地址永远可用。

always_off：地址永远不可用。

RectifiedGeos string[] 可选示例值：["cn_telecom_beijing"]

需要订正的目标地址归属区域。您需要在该参数中填入线路代号。例如，default 表示全部区域。参见线路代号了解线路代号与具体归属区域（即线路）的对应关系。如果您不设置该参数，那么云调度 GTM 不订正归属区域。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

PoolId string 示例值：cf65f46e-6a19-4d15-99b5-684a6ce4e7ff

地址池的 ID。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
401	鉴权失败	鉴权失败	鉴权失败
504	internal error	内部错误	内部错误

TrafficRoute DNS 套件