DeletePool-删除地址池--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

DeletePool-删除地址池

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

删除一个地址池。

注意

如果地址池所在的 GTM 实例正在使用该地址池，您需要在调用 StopRouting API 后，再调用该 API 删除地址池。

警告

地址池删除后不可恢复。如果您只是想从地址池集合中删除地址池，可以调用 UpdateRule API。

请求说明

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

请求参数

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

Query

名称	类型	是否必选	示例值	描述
Action	String	是	`DeletePool`	API 的名称。该参数的取值为 `DeletePool`。
Version	String	是	`2023-01-01`	API 的版本。该参数的取值是 `2023-01-01`。
GtmId	String	是	`2a8f91c4-aa07-4ae4-9ebc-68750d611822`	GTM 实例的 UUID。您可以通过 ListGtms API 获取 UUID。
PoolId	String	是	`cf65f46e-6a19-4d15-99b5-684a6ce4e7ff`	地址池的 ID。在您通过 CreatePool API 创建地址池时，可以通过返回值获取地址池的 ID。

返回参数

ResponseMetadata 对象

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

示例

请求示例

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

{
   "GtmId": "2a8f91c4-aa07-4ae4-9ebc-68750d611822",
   "PoolId": "cf65f46e-6a19-4d15-99b5-684a6ce4e7ff"
}

返回示例

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

错误码

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