CreatePool - 创建地址池--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

CreatePool - 创建地址池

最近更新时间：2025.05.28 17:49:13首次发布时间：2023.08.21 14:31:38

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

请求说明

请求方式：POST
请求地址：https://open.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 字符。

返回参数

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

参数	类型	示例值	描述
PoolId	String	cf65f46e-6a19-4d15-99b5-684a6ce4e7ff	地址池的 ID。

请求示例

POST https://open.volcengineapi.com/?Action=CreatePool&Version=2023-01-01

{
   "GtmId": "2a8f91c4-aa07-4ae4-9ebc-68750d611822",
   "Pool": {
       "Name": "example-pool",
       "Remark": "",
       "AddrType": "ipv4",
       "Addresses": [
           {
               "Value": "1.**.**.**",
               "Weight": 3,
               "RectifiedGeos": ["cn_telecom_beijing"],
               "Mode": "auto"
           }
       ]
   }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230727152318D60DAA2A8AF0E65F9619",
        "Action": "CreatePool",
        "Version": "2023-01-01",
        "Service": "GTM",
        "Region": "cn-north-1"
    },
    "Result": {
        "PoolId": "cf65f46e-6a19-4d15-99b5-684a6ce4e7ff"
    }
}

错误码

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

状态码	错误码	错误信息	说明
504	internal error	内部错误	内部错误