You can call this operation to query the details of a health check instance.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | No | DescribeHealthCheckAttribute |
The operation that you want to perform. Set the value to DescribeHealthCheckAttribute. |
HcInstanceId | String | Yes | hc-1k4ucuq77b56x4**** |
The ID of the health check instance. |
RegionId | String | Yes | cn-shanghai |
The ID of the region where the Smart Access Gateway (SAG) instance is deployed. |
SmartAGId | String | Yes | sag-1um5x5nwhilymw**** |
The ID of the SAG instance. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
CreateTime | Long | 1586759657000 |
The time when the health check instance was created. |
Description | String | hc-123 |
The description of the health check instance. |
DstIpAddr | String | 192.XX.XX.1 |
The destination IP address used by the health check instance. |
DstPort | Integer | 1223 |
The destination port used by the health check instance. Note This feature is not supported.
|
FailCountThreshold | Integer | 3 |
The number of failed probes before a health check is declared failed. Valid values: 1 to 15. Default value: 3. |
HcInstanceId | String | hc-1k4ucuq77b56x4**** |
The ID of the health check instance. |
Name | String | bvt-test-03**** |
The name of the health check instance. |
ProbeCount | Integer | 3 |
The number of probes performed per health check. Valid values: 1 to 20. Default value: 1. |
ProbeInterval | Integer | 2000 |
The time interval at which probes are performed. The next probe does not start before the current one is completed. Valid values: 1000 to 60000. Default value: 2000. Unit: millisecond. |
ProbeTimeout | Integer | 1000 |
The timeout period of a probe. Valid values: 10 to 30000. Default value: 1000. Unit: millisecond. |
RequestId | String | DDA08B78-5634-4A83-94E4-5C58FD7EBA19 |
The ID of the request. |
RttFailThreshold | Integer | 3 |
The number of times that the maximum round-trip time (RTT) is exceeded before an alert is triggered. Valid values: 1 to 15. Default value: 3. |
RttThreshold | Integer | 300 |
The RTT. Value values: -1 and 1 to 5000. Default value: -1. This value indicates that the RTT threshold is not specified. |
SmartAGId | String | sag-1um5x5nwhilymw**** |
The ID of the SAG instance. |
SrcIpAddr | String | 10.XX.XX.1 |
The source IP address used in health checks. |
SrcPort | Integer | 2334 |
The source port used in health checks. Note This feature is not supported.
|
Type | String | ICMP_ECHO |
The type of packet used in health checks. Only ICMP_ECHO is supported. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeHealthCheckAttribute
&HcInstanceId=hc-1k4ucuq77b56x4****
&RegionId=cn-shanghai
&SmartAGId=sag-1um5x5nwhilymw****
&<Common request parameters>
Sample success responses
XML
format
<DescribeHealthCheckAttributeResponse>
<CreateTime>1586759657000</CreateTime>
<Description>TEST</Description>
<SrcPort>44</SrcPort>
<RequestId>66ECCDF6-7290-44A6-A2D0-3B926CEE82C6</RequestId>
<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>
<SmartAGId>sag-4goc1sj3c978z2****</SmartAGId>
<RttFailThreshold>5</RttFailThreshold>
<DstIpAddr>12.XX.XX.1</DstIpAddr>
</DescribeHealthCheckAttributeResponse>
JSON
format
{
"CreateTime": 1586759657000,
"Description": "TEST",
"SrcPort": 44,
"RequestId": "66ECCDF6-7290-44A6-A2D0-3B926CEE82C6",
"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,
"SmartAGId": "sag-4goc1sj3c978z2****",
"RttFailThreshold": 5,
"DstIpAddr": "12.XX.XX.1"
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | HC.InstanceNoFound | The specified network health check instance does not exist. | The error message returned because the specified health check instance does not exist. |
For a list of error codes, visit the API Error Center.