You need to enable JavaScript to run this app.
导航
TrafficRoute DNS 套件
  • 文档首页
    • /TrafficRoute DNS 套件/云调度 GTM/API 参考/健康检查管理接口/GetProbe-获取策略的健康检查参数
GetProbe-获取策略的健康检查参数
最近更新时间：2024.09.02 16:25:28首次发布时间：2023.08.21 14:31:37
我的收藏

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

请求说明

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

请求参数

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

Query

名称类型是否必选示例值描述
ActionString是GetProbeAPI 的名称。该参数的取值是 GetProbe。
VersionString是2023-01-01API 的版本。该参数的取值是 2023-01-01。
GtmIdString是2a8f91c4-aa07-4ae4-9ebc-68750d611822GTM 实例的 UUID。您可以通过 ListGtms API 获取 GtmId。
PolicyTypeString是geo健康检查对应的策略类型。
  • geo：基础路由。
  • perf：智能路由。

返回参数

ResponseMetadata 对象

名称
类型
描述
RequestId
String
标识本次请求的 ID。
Action
String
Action 查询参数的值。
Version
String
API 版本。
Service
String
服务类型。
Region
String
服务所在区域。

Result 对象

名称
类型
描述
Nodes
String[]
健康检查探测点。
IsManualNodes
Boolean
是否手动配置健康检查探测点。
  • true：手动配置健康检查探测点。
  • false：使用推荐的健康检查探测点。
AdvisedNodeCount
Integer
推荐的健康检查探测点数量。
Protocol
String
健康检查使用的协议。
  • ping：ICMP 协议。
  • tcp：TCP 协议。
  • http：HTTP 协议。
  • https：HTTPS 协议。
Interval
Integer
每次健康检查的时间间隔。单位为秒。
Timeout
Integer
健康检查任务的超时时间。单位为秒。
PingLossRate
Integer
丢包率。单位为百分比。如果丢包率大于该参数的值，则判定为结果异常。例如，如果该参数为 10，且健康检查时的丢包率大于 10，则判定为结果异常。

该参数仅在健康检查协议设置为 ping 时有效。
PingCount
Integer
发包数量。如果您将该参数设置为 10，每次 ping 检查会同时发出 10 个数据包。

该参数仅在健康检查协议设置为 ping 时有效。
FailedCount
Integer
一个健康检查周期内，单个探测点的健康检查结果是否被判定为异常的建连失败率阈值。例如，您将该参数设为 10，如果某次健康检查的建连失败率大于 10%，则该探测点的该次健康检查结果被判定为异常。

该参数仅在健康检查协议设置为 tcp 时有效。
TcpConnTimeout
Integer
建立单个 TCP 连接的超时时间。例如，您将该参数设为 2 秒，如果某次健康检查中，TCP 连接从建立开始 2 秒内还没有建立成功，就会被判定为建连失败。

该参数仅在健康检查协议设置为 tcp 时有效。
Host
String
健康检查目标地址的完整域名。

该参数仅在健康检查协议设置为 HTTP 或 HTTPS 时有效。
Port
Integer
健康检查目标地址的端口。

该参数仅在健康检查协议设置为 HTTP 或 HTTPS 时有效。
Url
String
健康检查目标地址的 path 部分，以 / 开头。

该参数仅在健康检查协议设置为 HTTP 或 HTTPS 时有效。
HttpMethod
String
HTTP 请求方法。

该参数仅在健康检查协议设置为 HTTP 或 HTTPS 时有效。
HttpHeader
Object
健康检查使用的 HTTP 请求头。

该参数仅在健康检查协议设置为 HTTP 或 HTTPS 时有效。如果您没有设置 HTTP 请求头，该参数不会出现。
HttpUsabilityCodes
Array of objects
自定义一个 HTTP 状态码的范围。某个探测点发起健康检查后，如果目标地址返回了范围外的 HTTP 状态码，则该探测点的健康检查判定为失败。如果您没有为策略设置 HttpUsabilityCodes 参数，则该参数不会被返回。
Disable
Boolean
是否关闭了健康检查。
  • true：已关闭。
  • false：已开启。

示例

请求示例

POST https://open.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
    }
}

错误码

您可访问公共错误码，获取详细信息。