UpdatePool-更新地址池--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

UpdatePool-更新地址池

最近更新时间：2024.07.15 15:05:16首次发布时间：2023.08.21 14:31:38

更新一个地址池。

注意

该 API 会全量更新地址池的参数。如果您不设置某个可选参数的值，该参数会使用默认值。
如果地址池所在的 GTM 实例在运行中，您需要在调用 StopRouting API 后，再调用该 API 更新地址池。

请求说明

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

请求参数

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

Query

名称	类型	是否必选	示例值	描述
Action	String	是	`UpdatePool`	API 的名称。该参数的取值为 `UpdatePool`。
Version	String	是	`2023-01-01`	API 的版本。该参数的取值是 `2023-01-01`。

Body

名称	类型	是否必选	示例值	描述
GtmId	String	是	`5c7f5265-ca0f-4a60-bcd6-c4db7fcc4a95`	GTM 实例的 UUID。您可以通过 ListGtms API 获取 UUID。
PoolId	String	是	`e462d15f-cfba-4dd3-a42b-9c2a7c2d0e1b`	地址池的 ID。您可以通过 ListPools API 获取地址池的 ID。
Pool	Object	是		地址池。

返回参数

ResponseMetadata 对象

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

示例

请求示例

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

{
    "GtmId": "5c7f5265-ca0f-4a60-bcd6-c4db7fcc4a95",
    "PoolId": "e462d15f-cfba-4dd3-a42b-9c2a7c2d0e1b",
    "Pool": {
        "Name": "example-pool",
        "Remark": "",
        "AddrType": "ipv4",
        "Addresses": [
            {
                "Value": "1.1.1.1",
                "Weight": 3,
                "RectifiedGeos": [
                    "mobile"
                ],
                "Mode": "auto"
            }
        ]
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230727152318D60DAA2A8AF0E65F9619",
        "Action": "UpdatePool",
        "Version": "2023-01-01",
        "Service": "GTM",
        "Region": "cn-north-1"
    }
}

错误码

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