文档

DescribeHealthChecks - 查询智能接入网关实例下的健康检查实例

更新时间:

调用DescribeHealthChecks查询智能接入网关实例下的健康检查实例。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

智能接入网关实例的地域 ID。

cn-shanghai
SmartAGIdstring

智能接入网关实例 ID。

sag-qi0p07ld5q86k3****
HcInstanceIdstring

健康检查实例 ID。

hc-ifflm5ygj3diwiu****
Namestring

健康检查实例名称。

长度为 2~100 个字符,以大小字母或中文开头,可包含数字、半角句号(.)、下划线(_)或短划线(-)。

ddd3333
PageNumberinteger

当前分页页码。默认值为 1

1
PageSizeinteger

分页展示时,每页的列表条目数。默认值为 10,最大值为 50

10

返回参数

名称类型描述示例值
object
TotalCountinteger

总共的列表条目数。

5
PageSizeinteger

分页展示时,每页的列表条目数。默认值为 10,最大值为 50

10
RequestIdstring

请求 ID。

0B275FE6-FC86-4921-BC70-1B3DF68B078F
PageNumberinteger

当前分页的页码。默认值为 1

1
HealthChecksobject []

健康检查列表。

Typestring

健康检查报文类型,目前仅支持ICMP_ECHO

ICMP_ECHO
ProbeTimeoutinteger

一次探测的超时时间。

数值范围:10~30000

默认值:1000

单位:毫秒。

1000
Statusstring

健康检查状态:

  • success:成功。
  • failed:失败。
  • unknown:未开始。
unknown
DstIpAddrstring

健康检查的目的地址。

110.XX.XX.1
RelationCountinteger

关联健康检查实例的路由数量。

3
RttFailThresholdinteger

时延阈值触发次数。

数值范围:1~15

默认值:3

3
SmartAGIdstring

智能接入网关实例 ID。

sag-qi0p07ld5q86k3****
DstPortinteger

健康检查的目的端口。

说明 该功能目前不支持。
33
FailCountThresholdinteger

连续探测失败次数阈值。

数值范围:1~15

默认值:3

3
RttThresholdinteger

双向时延阈值。

数值范围:-11~5000

默认值:-1,表示不设置双向时延阈值。

单位:毫秒。

45
SrcPortinteger

健康检查的源端口。

说明 该功能目前不支持。
334
ProbeCountinteger

每次健康检查探测次数。

数值范围:1~20

默认值:1

2
Descriptionstring

健康检查描述。

健康检查
SrcIpAddrstring

健康检查的源地址。

192.XX.XX.1
ProbeIntervalinteger

健康检查探测间隔,一次探测未完成情况下,不会发起下一次探测。

数值范围:1000~60000

默认值:2000

单位:毫秒。

2000
Namestring

健康检查实例名称。

doctest
HcInstanceIdstring

健康检查实例 ID。

hc-ifflm5ygj3diwi****

示例

正常返回示例

JSON格式

{
  "TotalCount": 5,
  "PageSize": 10,
  "RequestId": "0B275FE6-FC86-4921-BC70-1B3DF68B078F",
  "PageNumber": 1,
  "HealthChecks": {
    "HealthCheck": [
      {
        "Type": "ICMP_ECHO",
        "ProbeTimeout": 1000,
        "Status": "unknown",
        "DstIpAddr": "110.XX.XX.1",
        "RelationCount": 3,
        "RttFailThreshold": 3,
        "SmartAGId": "sag-qi0p07ld5q86k3****",
        "DstPort": 33,
        "FailCountThreshold": 3,
        "RttThreshold": 45,
        "SrcPort": 334,
        "ProbeCount": 2,
        "Description": "健康检查",
        "SrcIpAddr": "192.XX.XX.1",
        "ProbeInterval": 2000,
        "Name": "doctest",
        "HcInstanceId": "hc-ifflm5ygj3diwi****"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400SAG.InstanceIdEmptyYou must specify the SAG instance ID.智能接入网关实例ID为空。
400SAG.InstanceNoFoundThe specified SAG instance does not exist.智能接入网关实例不存在。

访问错误中心查看更多错误码。