TrafficRoute DNS 套件
TrafficRoute DNS 套件
云调度
请输入
- 文档首页
TrafficRoute DNS 套件API 参考路由规则管理UpdateRule - 更新路由规则
复制全文
下载 pdfUpdateRule - 更新路由规则
文档反馈
问问助手更新一条路由规则。
注意事项
- 该 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
PolicyType string 必选 示例值：geo
路由规则对应的策略类型。
- geo：基础路由。
- perf：智能路由。
RuleId string 必选 示例值：c3f65de3-7b01-4ad5-8225-d0e42ced2e05
Rule object 必选 示例值：无
路由规则。
UseRuleProbeConfig boolean 可选 示例值：false
是否使用路由规则级别的拨测配置。默认值：false。
- true：使用
- false：（默认）不使用
UsePolicyProbeNodes boolean 可选 示例值：false
是否继承实例级别的健康检查节点。默认值：false。
- true：继承
- false：（默认）不继承
Name string 必选 示例值：rule
路由规则的名称。
Remark string 可选 示例值：remark
路由规则的备注。默认为空字符串。UTF-8 格式。最大长度为 128 个 UTF-8 字符。
Disable boolean 可选 示例值：true
是否禁用该路由规则。默认值：false。
- true：禁用该路由规则。
- false：（默认）启用该路由规则。
Line string 可选 示例值：default
Weight integer 可选 示例值：1
PoolSets object[] 可选 示例值：无
一个或多个地址池集合。数组的顺序代表了地址池集合的优先级。
Name string 必选 示例值：poolset
地址池集合的名称。UTF-8 格式。最大长度为 32 个 UTF-8 字符。
Pools object[] 必选 示例值：无
地址池集合包含的一个或多个地址池。
PoolId string 必选 示例值：cf65f46e-6a19-4d15-99b5-684a6ce4e7ff
Weight integer 可选 示例值：1
ActiveAddrThr integer 必选 示例值：1
地址池集合判定为可用的最小可用地址数。例如，您将该参数设为 1。如果存在 1 个或更多可用地址，则该地址池集合可用。否则，该地址池集合不可用。默认值为 1。当健康检查未启用时，每个地址池集合都默认可用。
Probe object 可选 示例值：无
路由规则的健康检查参数。
HttpUsabilityCodes object[] 可选 示例值：无
自定义一个 HTTP 状态码的范围。某个探测点发起健康检查后，如果目标地址返回了范围外的 HTTP 状态码，则该探测点的健康检查判定为失败。如果您没有为路由规则设置 HttpUsabilityCodes 参数，则该参数不会被返回。
Operator string 可选 示例值：exclude
操作符。
- interval：匹配区间内的值。
- include：匹配指定的值。
- exclude：匹配指定值以外的值。
Codes integer[] 可选 示例值：[0,200]
HTTP 状态码列表。
Disable boolean 可选 示例值：true
健康检查是否被禁用。
- true：被禁用。
- false：未被禁用。
Protocol string 可选 示例值：ping
健康检查使用的协议。
- ping：ICMP 协议。
- tcp：TCP 协议。
- http：HTTP 协议。
- https：HTTPS 协议。
Interval integer 可选 示例值：15
每次健康检查的时间间隔。单位为秒。
Nodes string[] 可选 示例值：无
健康检查探测点。
IsManualNodes boolean 可选 示例值：true
是否手动配置健康检查探测点。
- true：手动配置健康检查探测点。
- false：使用推荐的健康检查探测点。
Timeout integer 可选 示例值：6
健康检查任务的超时时间。单位为秒。
- ping：如果延时大于 Timeout 的值，则判定为丢包。
- http/https：如果延时大于 Timeout 的值，则判定为结果异常。
AdvisedNodeCount integer 可选 示例值：6
推荐的健康检查探测点数量。
PingCount integer 可选 示例值：10
发包数量。如果您将该参数设置为 10，每次 ping 检查会同时发出 10 个数据包。该参数仅在健康检查协议设置为 ping 时有效。
PingLossPercent integer 可选 示例值：10
丢包率。单位为百分比。如果丢包率大于该参数的值，则判定为结果异常。例如，如果该参数为 10，且健康检查时的丢包率为 11%，则判定为结果异常。该参数仅在健康检查协议设置为 ping 时有效。
FailedCount integer 可选 示例值：3
单个目标地址是否被判定为故障的健康检查失败次数阈值。例如，如果您将该参数设为 3，单个目标地址连续出现 3 次健康检查失败，则该地址被判定为故障地址。默认值为 3。
Host string 可选 示例值：www.example.com
健康检查目标地址的域名。该参数仅在健康检查协议设置为 HTTP 或 HTTPS 时有效。
Port integer 可选 示例值：80
健康检查目标地址的端口。该参数仅在健康检查协议设置为 HTTP 或 HTTPS 时有效。
Url string 可选 示例值：/docs/abc
健康检查目标地址的 path 部分，以 / 开头。该参数仅在健康检查协议设置为 HTTP 或 HTTPS 时有效。
HttpMethod string 可选 示例值：get
HTTP 请求方法。该参数仅在健康检查协议设置为 HTTP 或 HTTPS 时有效。
HttpHeader object 可选 示例值：无
健康检查使用的 HTTP 请求头。该参数仅在健康检查协议设置为 HTTP 或 HTTPS 时有效。
PoolSetMode string 可选 示例值：auto
地址池集合的生效模式。
- （默认）auto：自动设置生效的地址池集合。优先级最高的可用地址池自动生效。如果所有地址池都不可用，则优先级最高的地址池生效。
- manual：手动设置生效的地址池集合。在该模式下，您需要在 EffectivePoolSetIndex 参数中设置生效的地址池集合的索引。
EffectivePoolSetIndex integer 可选 示例值：0
生效的地址池集合的索引，从 0 开始。默认为 0。索引对应了地址池在 PoolSets 参数中的地址池集合数组中的位置。您把 PoolSetMode 设置为 manual 时，如果当前地址池集合不可用，无论该参数设置的地址池集合是否可用，云调度 GTM 都会切换到该参数设置的地址池集合。
返回参数
请求示例
POST /?Action=UpdateRule&Version=2023-01-01 HTTP/1.1
Host: gtm.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20260228T070255Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260228/cn-beijing/gtm/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
"GtmId": "2a8f91c4-aa07-4ae4-9ebc-68750d611822",
"PolicyType": "geo",
"RuleId": "c3f65de3-7b01-4ad5-8225-d0e42ced2e05",
"Rule": {
"UseRuleProbeConfig": true,
"UsePolicyProbeNodes": true,
"Name": "rule",
"Remark": "remark",
"Disable": true,
"Line": "default",
"Weight": 1,
"PoolSets": [
{
"Name": "poolset",
"Pools": [
{
"PoolId": "cf65f46e-6a19-4d15-99b5-684a6ce4e7ff",
"Weight": 1
}
],
"ActiveAddrThr": 1
}
],
"Probe": {
"HttpUsabilityCodes": [
{
"Operator": "exclude",
"Codes": [
0
]
}
],
"Disable": true,
"Protocol": "ping",
"Interval": 15,
"Nodes": [
"无"
],
"IsManualNodes": true,
"Timeout": 6,
"AdvisedNodeCount": 6,
"PingCount": 10,
"PingLossPercent": 10,
"FailedCount": 3,
"Host": "www.example.com",
"Port": 80,
"Url": "/docs/abc",
"HttpMethod": "get",
"HttpHeader": {}
},
"PoolSetMode": "auto",
"EffectivePoolSetIndex": 0
}
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20260228150306083102096230374728",
"Action": "UpdateRule",
"Version": "2023-01-01",
"Service": "gtm",
"Region": "cn-beijing"
},
"Result": {}
}
错误码
状态码 | 错误码 | 错误信息 | 说明 |
504 | internal error | 内部错误 | 内部错误 |
最近更新时间：2026.02.28 16:23:53
这个页面对您有帮助吗？
有用
有用
无用
无用