You need to enable JavaScript to run this app.
导航
TrafficRoute DNS 套件
  • 文档首页
    • /TrafficRoute DNS 套件/云调度 GTM/API 参考/路由规则管理接口/DeleteRule-删除路由规则
DeleteRule-删除路由规则
最近更新时间：2024.07.15 14:48:43首次发布时间：2023.08.21 14:31:38
我的收藏

删除一条路由规则。

警告

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

如果该路由规则所在的 GTM 实例正在运行，您需要在删除路由规则前，调用 StopRouting API 停止 GTM 实例。

请求说明

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

请求参数

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

Query

名称类型是否必选示例值描述
ActionString是DeleteRuleAPI 的名称。该参数的取值是 DeleteRule。
VersionString是2023-01-01API 的版本。该参数的取值是 2023-01-01。

Body

名称类型是否必选示例值描述
GtmIdString是2a8f91c4-aa07-4ae4-9ebc-68750d611822GTM 实例的 UUID。您可以通过 ListGtms API 获取 UUID。
PolicyTypeString是geo路由规则对应的策略类型。
  • geo：基础路由。
  • perf：智能路由。
RuleIdString是c3f65de3-7b01-4ad5-8225-d0e42ced2e05路由规则的 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",
  "PolicyType": "geo",
	"RuleId": "c3f65de3-7b01-4ad5-8225-d0e42ced2e05"
}

返回示例

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

错误码

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