DescribeHealthChecks - 智能接入网关

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeHealthChecks	系统规定参数。取值：DescribeHealthChecks。
RegionId	String	是	cn-shanghai	智能接入网关实例的地域ID。
SmartAGId	String	是	sag-qi0p07ld5q86k3****	智能接入网关实例ID。
HcInstanceId	String	否	hc-ifflm5ygj3diwiu****	健康检查实例ID。
Name	String	否	ddd3333	健康检查实例名称。长度为2~100个字符，以大小字母或中文开头，可包含数字、半角句号（.）、下划线（_）或短划线（-）。
PageNumber	Integer	否	1	当前分页页码。默认值为1。
PageSize	Integer	否	10	分页展示时，每页的列表条目数。默认值为10，最大值为50。

返回数据


名称	类型	示例值	描述
TotalCount	Integer	5	总共的列表条目数。
PageSize	Integer	10	分页展示时，每页的列表条目数。默认值为10，最大值为50。
RequestId	String	0B275FE6-FC86-4921-BC70-1B3DF68B078F	请求ID。
PageNumber	Integer	1	当前分页的页码。默认值为1。
HealthChecks	Array of HealthCheck		健康检查列表。
HealthCheck
Type	String	ICMP_ECHO	健康检查报文类型，目前仅支持ICMP_ECHO。
ProbeTimeout	Integer	1000	一次探测的超时时间。数值范围：10~30000。默认值：1000。单位：毫秒。
Status	String	unknown	健康检查状态： success：成功。 failed：失败。 unknown：未开始。
DstIpAddr	String	110.XX.XX.1	健康检查的目的地址。
RelationCount	Integer	3	关联健康检查实例的路由数量。
RttFailThreshold	Integer	3	时延阈值触发次数。数值范围：1~15。默认值：3。
SmartAGId	String	sag-qi0p07ld5q86k3****	智能接入网关实例ID。
DstPort	Integer	33	健康检查的目的端口。说明该功能目前不支持。
FailCountThreshold	Integer	3	连续探测失败次数阈值。数值范围：1~15。默认值：3。
RttThreshold	Integer	45	双向时延阈值。数值范围：-1或1~5000。默认值：-1，表示不设置双向时延阈值。单位：毫秒。
SrcPort	Integer	334	健康检查的源端口。说明该功能目前不支持。
ProbeCount	Integer	2	每次健康检查探测次数。数值范围：1~20。默认值：1。
Description	String	健康检查	健康检查描述。
SrcIpAddr	String	192.XX.XX.1	健康检查的源地址。
ProbeInterval	Integer	2000	健康检查探测间隔，一次探测未完成情况下，不会发起下一次探测。数值范围：1000~60000。默认值：2000。单位：毫秒。
Name	String	doctest	健康检查实例名称。
HcInstanceId	String	hc-ifflm5ygj3diwi****	健康检查实例ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeHealthChecks
&RegionId=cn-shanghai
&SmartAGId=sag-qi0p07ld5q86k3****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeHealthChecksResponse>
<TotalCount>1</TotalCount>
<PageSize>10</PageSize>
<RequestId>97575E44-B01C-4F8B-B829-3272A312F196</RequestId>
<PageNumber>1</PageNumber>
<HealthChecks>
    <HealthCheck>
        <Status>unknown</Status>
        <Description>TEST</Description>
        <SrcPort>44</SrcPort>
        <SrcIpAddr>2.XX.XX.1</SrcIpAddr>
        <FailCountThreshold>3</FailCountThreshold>
        <DstPort>33</DstPort>
        <Name>TEST</Name>
        <ProbeCount>5</ProbeCount>
        <Type>ICMP_ECHO</Type>
        <ProbeTimeout>30</ProbeTimeout>
        <HcInstanceId>hc-l3x9k16ag24d6j****</HcInstanceId>
        <RttThreshold>-1</RttThreshold>
        <ProbeInterval>2000</ProbeInterval>
        <RelationCount>1</RelationCount>
        <SmartAGId>sag-4goc1sj3c978z2****</SmartAGId>
        <RttFailThreshold>5</RttFailThreshold>
        <DstIpAddr>12.XX.XX.1</DstIpAddr>
    </HealthCheck>
</HealthChecks>
</DescribeHealthChecksResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "PageSize" : 10,
  "RequestId" : "97575E44-B01C-4F8B-B829-3272A312F196",
  "PageNumber" : 1,
  "HealthChecks" : {
    "HealthCheck" : [ {
      "Status" : "unknown",
      "Description" : "TEST",
      "SrcPort" : 44,
      "SrcIpAddr" : "2.XX.XX.1",
      "FailCountThreshold" : 3,
      "DstPort" : 33,
      "Name" : "TEST",
      "ProbeCount" : 5,
      "Type" : "ICMP_ECHO",
      "ProbeTimeout" : 30,
      "HcInstanceId" : "hc-l3x9k16ag24d6j****",
      "RttThreshold" : -1,
      "ProbeInterval" : 2000,
      "RelationCount" : 1,
      "SmartAGId" : "sag-4goc1sj3c978z2****",
      "RttFailThreshold" : 5,
      "DstIpAddr" : "12.XX.XX.1"
    } ]
  }
}

错误码


HttpCode	错误码	错误信息	描述
400	SAG.InstanceIdEmpty	You must specify the SAG instance ID.	智能接入网关实例ID为空。
400	SAG.InstanceNoFound	The specified SAG instance does not exist.	智能接入网关实例不存在。

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