UpdateRule - 更新路由规则--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

UpdateRule - 更新路由规则

最近更新时间：2025.07.21 11:55:22首次发布时间：2023.08.21 14:31:38

更新一条路由规则。

注意事项

该 API 会全量更新路由规则的参数。如果您不设置某个可选参数的值，该参数会使用默认值。
如果路由规则所在的 GTM 实例在运行中，您需要在调用 StopRouting API 后，再调用该 API 更新路由规则。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	UpdateRule	要执行的操作，取值：UpdateRule。
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。您可以通过 ListRules API 获取路由规则的 ID。
Rule	Object	是	无	路由规则。

返回参数

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

请求示例

POST https://gtm.volcengineapi.com/?Action=UpdateRule&Version=2023-01-01

{
	"GtmId": "2a8f91c4-aa07-4ae4-9ebc-68750d611822",
  "RuleId": "c3f65de3-7b01-4ad5-8225-d0e42ced2e05",
	"Rule": {
		"Name": "TestRule",
		"Remark": "",
		"Disable": false,
		"Line": "default",
		"Weight": 1,
		"PoolSets": [
			{
				"Name": "PoolSet1",
				"Pools": [
					{
						"PoolId": "cf65f46e-6a19-4d15-99b5-684a6ce4e7ff",
						"Weight": 1
					}
				]
			}
		],
		"Probe": {
			"Disable": false
		},
		"UseRuleProbeConfig": false,
		"UsePolicyProbeNodes": false
	}
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023072718230548623722C3A60BA95BBE",
        "Action": "UpdateRule",
        "Version": "2023-01-01",
        "Service": "GTM",
        "Region": "cn-north-1"
    }
}

错误码

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

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