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

文档中心

立即注册

导航

TrafficRoute DNS 套件

DeletePool - 删除地址池

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

删除一个地址池。

注意事项

如果地址池所在的 GTM 实例正在使用该地址池，您需要在调用 StopRouting API 后，再调用该 API 删除地址池。
地址池删除后不可恢复。如果您只是想从地址池集合中删除地址池，可以调用 UpdateRule API。

请求说明

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

调试

API Explorer

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

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	DeletePool	要执行的操作，取值：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 或 ListPools API 获取地址池的 ID。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

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"
    }
}

错误码

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

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