TrafficRoute DNS 套件
TrafficRoute DNS 套件
云调度
请输入
- 文档首页
TrafficRoute DNS 套件API 参考健康检查管理UpdateProbe - 更新策略的健康检查参数
复制全文
下载 pdfUpdateProbe - 更新策略的健康检查参数
文档反馈
问问助手更新指定 GTM 实例下某条路由策略的健康检查参数。
请求说明
- 请求方式：POST
- 请求地址：https://gtm.volcengineapi.com/?Action=UpdateProbe&Version=2023-01-01
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：UpdateProbe
要执行的操作，取值：UpdateProbe。
Version string 必选 示例值：2023-01-01
API的版本，取值：2023-01-01。
GtmId string 必选 示例值：2a8f91c4-aa07-4ae4-9ebc-68750d611822
PolicyType string 必选 示例值：geo
健康检查对应的策略类型。取值：
- geo：基础路由。
- perf：智能路由。
Probe object 必选 示例值：参见请求示例
策略的健康检查参数。
HttpUsabilityCodes object[] 可选 示例值：[{"Operator": "interval", "Codes": [100,200]}]
自定义健康检查的 HTTP 状态码判定规则，可配置一组或多组。探测点发起检查后，若目标地址返回的状态码不满足此处规则，则该探测点判定为失败。未配置时默认：状态码在 200~399 视为健康，其余视为失败。
Operator string 可选 示例值：interval
状态码匹配操作符，与 Codes 配合判定探测是否成功。取值：
- interval：（匹配区间内的状态码）
- include：（匹配列表内的状态码）
- exclude：（匹配列表以外的状态码）。
Codes integer[] 可选 示例值：[100,200]
HTTP 状态码列表，取值范围 100~599。当 Operator 为 interval 时须填 2 个值，分别表示区间的下限与上限（如 [100,200] 表示 100~200）；当 Operator 为 include 或 exclude 时须至少填 1 个值。
Disable boolean 可选 示例值：true
是否关闭健康检查。取值：
- true：关闭健康检查。
- false：（默认）开启健康检查。
Protocol string 可选 示例值：ping
健康检查使用的协议。取值：
- ping：ICMP 协议。
- tcp：TCP 协议。
- http：HTTP 协议。
- https：HTTPS 协议。
Interval integer 可选 示例值：60
- 60：（默认）健康检查的时间间隔是 60 秒。
- 15：健康检查的时间间隔是 15 秒。
Nodes string[] 可选 示例值：无
该参数无实际意义。您可以忽略该参数。
IsManualNodes boolean 可选 示例值：无
该参数无实际意义。您可以忽略该参数。
Timeout integer 可选 示例值：5
健康检查任务的超时时间。单位为秒。
- ping：如果延时大于 Timeout 的值，则判定为丢包。
- http/https：如果延时大于 Timeout 的值，则判定为结果异常。
AdvisedNodeCount integer 可选 示例值：无
该参数无实际意义。您可以忽略该参数。
PingCount integer 可选 示例值：10
发包数量。如果您将该参数设置为 10，每次 ping 检查会同时发出 10 个数据包。如果您将 Protocol 参数设置为 ping，则该参数为必填参数。如果您将 Protocol 参数设置为其他值，则该参数无效。
PingLossPercent integer 可选 示例值：10
判定为异常的丢包率阈值。单位为百分比。如果丢包率大于该参数的值，则判定为结果异常。例如，如果该参数为 10，且健康检查时的丢包率为 11%，则判定为结果异常。
如果您将 Protocol 参数设置为 ping，则该参数为必填参数。如果您将 Protocol 参数设置为其他值，则该参数无效。
FailedCount integer 可选 示例值：3
单个目标地址是否被判定为故障的健康检查失败次数阈值。例如，如果您将该参数设为 3，单个目标地址连续出现 3 次健康检查失败，则该地址被判定为故障地址。默认值为 3。
Host string 可选 示例值：www.example.com
健康检查目标地址的完整域名。该参数仅在健康检查协议设置为 HTTP 或 HTTPS 时有效。
Port integer 可选 示例值：80
健康检查目标地址的端口。如果您将 Protocol 参数设置为 http 或 https，则该参数为必填参数。如果您将 Protocol 参数设置为其他值，则该参数无效。
Url string 可选 示例值：/content/pages
健康检查目标地址的 path 部分，以 / 开头。如果您将 Protocol 参数设置为 http 或 https，则该参数为必填参数。如果您将 Protocol 参数设置为其他值，则该参数无效。
HttpMethod string 可选 示例值：get
健康检查使用的 HTTP 请求方法。取值：
- get
- post
- head
- put
如果您将 Protocol 参数设置为 http 或 https，则该参数为必填参数。如果您将 Protocol 参数设置为其他值，则该参数无效。
HttpHeader object 可选 示例值：{"Content-type": "application/json","Content-Length": "1234"}
健康检查使用的 HTTP 请求头。如果您将 Protocol 参数设置为 http 或 https，则该参数为必填参数。如果您将 Protocol 参数设置为其他值，则该参数无效。
返回参数
请求示例
返回示例
错误码
状态码 | 错误码 | 错误信息 | 说明 |
504 | internal error | 内部错误 | 内部错误 |
最近更新时间：2026.07.23 11:46:09
这个页面对您有帮助吗？
有用
有用
无用
无用