You need to enable JavaScript to run this app.
导航
删除 GTM 实例
最近更新时间:2023.08.24 19:21:39首次发布时间:2023.08.21 14:31:37

API 说明

API 名称:DeleteGtm
API 域名:open.volcengineapi.com
API 描述:删除指定的 GTM 实例。

说明

  • 如果您希望云调度 GTM 取消对指定的 GTM 实例的计费,您需要删除该 GTM 实例。
  • 删除指定的 GTM 实例后,从调度域名到流量目标的 DNS 解析也会被删除。

警告

删除 GTM 实例前,请慎重考虑。删除后的 GTM 实例不能恢复,只能重新创建。如果您只是希望暂时使该 GTM 实例的故障转移暂时不生效,同时您希望保留从调度域名到目标地址的 DNS 解析,可以调用 StopRouting API 停止自动流量路由。

请求方法

POST

请求参数

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

参数名称
数据类型参数类型是否必选参数说明
ActionString查询参数API 的名称。该参数的取值是 DeleteGtm
VersionString查询参数API 的版本。该参数的取值是 2021-07-05
GtmIdString请求正文参数GTM 实例的 UUID。您可以通过 ListGtms API 获取 GtmId

响应正文

ResponseMetadata 对象

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

示例

请求示例

POST http://open.volcengineapi.com?Action=DeleteGtm&Version=2023-01-01
{
	"GtmId": "e93cb374-2b33-4202-842f-c066a4462c03"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20230216205017244FACA34B88E6F73574",
        "Action": "DeleteGtm",
        "Version": "2023-01-01",
        "Service": "gtm",
        "Region": "cn-north-1"
    }
}