GetProbe - 获取策略的健康检查参数--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

GetProbe - 获取策略的健康检查参数

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

获取一个 GTM 实例下的策略的健康检查参数。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	GetProbe	要执行的操作，取值：GetProbe。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
GtmId	String	是	2a8f91c4-aa07-4ae4-9ebc-68750d611822	GTM 实例的 UUID。您可以通过 ListGtms API 获取 `GtmId`。
PolicyType	String	是	geo	健康检查对应的策略类型。 geo：基础路由。 perf：智能路由。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Disable	Boolean	false	是否关闭了健康检查。 true：已关闭。 false：已开启。
Protocol	String	ping	健康检查使用的协议。 ping：ICMP 协议。 tcp：TCP 协议。 http：HTTP 协议。 https：HTTPS 协议。
Interval	Integer	15	每次健康检查的时间间隔。单位为秒。
Nodes	Array of String	无	健康检查探测点。
IsManualNodes	Boolean	true	是否手动配置健康检查探测点。 true：手动配置健康检查探测点。 false：使用推荐的健康检查探测点。
Timeout	Integer	5	健康检查任务的超时时间。单位为秒。
AdvisedNodeCount	Integer	6	推荐的健康检查探测点数量。
PingCount	Integer	10	发包数量。如果您将该参数设置为 10，每次 ping 检查会同时发出 10 个数据包。该参数仅在健康检查协议设置为 ping 时有效。
PingLossPercent	Integer	20	丢包率。单位为百分比。如果丢包率大于该参数的值，则判定为结果异常。例如，如果该参数为 10，且健康检查时的丢包率大于 10，则判定为结果异常。该参数仅在健康检查协议设置为 ping 时有效。
TcpConnTimeout	Integer	2	建立单个 TCP 连接的超时时间。例如，您将该参数设为 2 秒，如果某次健康检查中，TCP 连接从建立开始 2 秒内还没有建立成功，就会被判定为建连失败。该参数仅在健康检查协议设置为 tcp 时有效。
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	{ "Content-Length": "1234", "Content-type": "application/json" }	健康检查使用的 HTTP 请求头。该参数仅在健康检查协议设置为 HTTP 或 HTTPS 时有效。如果您没有设置 HTTP 请求头，该参数不会出现。
HttpUsabilityCodes	Array of Object	无	自定义一个 HTTP 状态码的范围。某个探测点发起健康检查后，如果目标地址返回了范围外的 HTTP 状态码，则该探测点的健康检查判定为失败。如果您没有为策略设置 `HttpUsabilityCodes` 参数，则该参数不会被返回。

请求示例

POST https://gtm.volcengineapi.com/?Action=GetProbe&Version=2023-01-01&GtmId=2a8f91c4-aa07-4ae4-9ebc-68750d611822&PolicyType=geo

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240528161514EA0FC160F40008023DD4",
        "Action": "GetProbe",
        "Version": "2023-01-01",
        "Service": "GTM",
        "Region": "cn-north-1"
    },
    "Result": {
        "Nodes": [
            "福建 厦门市 中国移动",
            "江西 南昌市 中国移动",
            "山东 济南市 中国移动",
            "江西 南昌市 中国联通",
            "山东 济南市 中国联通",
            "山西 太原市 中国电信",
            "山东 青岛市 中国电信",
            "山东 济南市 中国电信"
        ],
        "IsManualNodes": true,
        "AdvisedNodeCount": 8,
        "Protocol": "https",
        "Interval": 60,
        "Timeout": 5,
        "PingLossPercent": 10,
        "PingCount": 20,
        "FailedCount": 3,
        "TcpConnTimeout": 2,
        "Host": "example.com",
        "Port": 80,
        "Url": "/docs",
        "HttpMethod": "get",
        "HttpHeader": {
            "Content-Length": "1234",
            "Content-type": "application/json"
        },
        "Disable": true
    }
}

错误码

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

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