You need to enable JavaScript to run this app.
导航
TrafficRoute DNS 套件
  • 文档首页
    • /
  • TrafficRoute DNS 套件

删除路由规则

最近更新时间：2023.08.24 19:21:41

首次发布时间：2023.08.21 14:31:38

我的收藏

API 说明

API 名称：DeleteRule。
API 域名：open.volcengineapi.com。
API 描述：删除指定的路由规则。

警告

删除路由规则前，请慎重考虑。删除后的路由规则不能恢复，只能重新创建。如果您只是希望暂时使该路由规则失效，可以调用 UpdateRule API 停用该路由规则。

在删除路由规则前，您需要调用 StopRouting API 停用该路由规则所在的 GTM 实例的自动流量路由。

请求方法

POST

请求参数

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

参数名称
数据类型参数类型是否必选参数说明
ActionString查询参数是API 的名称。该参数的取值是 DeleteRule。
VersionString查询参数是API 的版本。该参数的取值是 2023-01-01。
GtmIdString请求正文参数是GTM 实例的 UUID。您可以通过 ListGtms API 获取 UUID。
RuleIdString请求正文参数是路由规则的 ID。您在调用 CreateRule API 时，响应正文中包含路由规则的 ID。

响应正文

ResponseMetadata 对象

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

示例

请求示例

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

{
		"GtmId": "2a8f91c4-aa07-4ae4-9ebc-68750d611822",
	  "RuleId": "c3f65de3-7b01-4ad5-8225-d0e42ced2e05"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "2022111713414601017424613601224A27",
        "Action": "DeleteRule",
        "Version": "2023-01-01",
        "Service": "gtm",
        "Region": "cn-north-1"
    }
}