You need to enable JavaScript to run this app.
导航
删除地址池
最近更新时间:2023.08.24 19:21:40首次发布时间:2023.08.21 14:31:38

API 说明

API 名称:DeletePool
API 域名:open.volcengineapi.com
API 描述:删除指定的地址池。

注意

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

警告

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

请求参数

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

参数名称

数据类型

参数类型

是否必选

参数说明

Action

String

查询参数

API 的名称。该参数的取值为 GetPool

Version

String

查询参数

API 的版本。该参数的取值是 2023-01-01

GtmId

String

查询参数

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

PoolId

String

查询参数

地址池的 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"
    }
}