StopRouting-停止 GTM 实例--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

StopRouting-停止 GTM 实例

最近更新时间：2024.07.15 14:47:36首次发布时间：2023.08.21 14:31:37

停止一个 GTM 实例。

说明

停止后，GTM 实例的健康检查和故障转移也会停止。但是，从调度域名到目标地址的 DNS 解析并不会停止。如果您需要删除从调度域名到目标地址的 DNS 解析，你可以调用 DeleteGtm API 删除 GTM 实例。

请求说明

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

请求参数

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

Query

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

Body

名称	类型	是否必选	示例值	描述
GtmId	String	是	`b46cf3dc-10e5-4847-8e32-e5c7696eebd0`	GTM 实例的 UUID。您可以通过 ListGtms API 获取 `GtmId`。

返回参数

ResponseMetadata 对象

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

示例

请求示例

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

{
	"GtmId":"b46cf3dc-10e5-4847-8e32-e5c7696eebd0"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221114164840010174249120049D6324",
        "Action": "StopRouting",
        "Version": "2023-01-01",
        "Service": "gtm",
        "Region": "cn-north-1"
    }
}

错误码

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