DeleteRule - 删除路由规则--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

DeleteRule - 删除路由规则

最近更新时间：2025.05.28 17:43:39首次发布时间：2023.08.21 14:31:38

删除一条路由规则。

注意事项

删除路由规则前，请慎重考虑。删除后的路由规则不能恢复，只能重新创建。如果您只是希望暂时使该路由规则失效，可以调用 UpdateRule API 停用该路由规则。
如果该路由规则所在的 GTM 实例正在运行，您需要在删除路由规则前，调用 StopRouting API 停止 GTM 实例。

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	DeleteRule	要执行的操作，取值：DeleteRule。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
GtmId	String	是	2a8f91c4-aa07-4ae4-9ebc-68750d611822	GTM 实例的 UUID。您可以通过 ListGtms API 获取 UUID。
PolicyType	String	是	geo	路由规则对应的策略类型。 geo：基础路由。 perf：智能路由。
RuleId	String	是	c3f65de3-7b01-4ad5-8225-d0e42ced2e05	路由规则的 ID。您在调用 CreateRule API 时，返回参数中包含路由规则的 ID。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

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"
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
504	internal error	内部错误	内部错误