All Products
Search
Document Center

Smart Access Gateway:DescribeHealthCheckAttribute

Last Updated:Mar 03, 2024

Queries the detailed information about a health check instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the health check instance.

cn-shanghai
HcInstanceIdstringYes

The ID of the SAG instance.

hc-1k4ucuq77b56x4****
SmartAGIdstringYes

The source port of the health check instance.

Note This feature is not supported.
sag-1um5x5nwhilymw****

Response parameters

ParameterTypeDescriptionExample
object
SrcPortinteger

The description of the health check instance.

2334
Descriptionstring

The ID of the request.

hc-123
RequestIdstring

The source IP address of the health check.

DDA08B78-5634-4A83-94E4-5C58FD7EBA19
SrcIpAddrstring

The time when the health check instance was created. This value is a UNIX timestamp.

Unit: milliseconds.

10.XX.XX.1
CreateTimelong

The maximum number of failed probes before the health check is declared failed.

Valid values: 1 to 15.

Default value: 3.

1586759657000
FailCountThresholdinteger

The destination port of the health check instance.

Note This feature is not supported.
3
DstPortinteger

The name of the health check instance.

1223
Namestring

The number of probes performed per health check.

Valid values: 1 to 20.

Default value: 1.

bvt-test-03****
ProbeCountinteger

The type of packets used in the health check.

Only ICMP_ECHO is supported.

3
Typestring

The timeout period of the probe.

Valid values: 10 to 30000.

Default value: 1000.

Unit: milliseconds.

ICMP_ECHO
ProbeTimeoutinteger

The ID of the health check instance.

1000
HcInstanceIdstring

The maximum round-trip time (RTT).

Value values: -1 and 1 to 5000.

Default value: -1. This value indicates that the RTT threshold is not specified.

hc-1k4ucuq77b56x4****
RttThresholdinteger

The time interval at which probes are performed. The next probe does not start before the current one is complete.

Valid values: 1000 to 60000.

Default value: 2000.

Unit: milliseconds.

300
ProbeIntervalinteger

The ID of the SAG instance.

2000
SmartAGIdstring

The number of times that the maximum RTT is exceeded before an alert is triggered.

Valid values: 1 to 15.

Default value: 3.

sag-1um5x5nwhilymw****
RttFailThresholdinteger

The destination IP address of the health check.

3

Examples

Sample success responses

JSONformat

{
  "SrcPort": 2334,
  "Description": "hc-123",
  "RequestId": "DDA08B78-5634-4A83-94E4-5C58FD7EBA19",
  "SrcIpAddr": "10.XX.XX.1",
  "CreateTime": 1586759657000,
  "FailCountThreshold": 3,
  "DstPort": 1223,
  "Name": "bvt-test-03****",
  "ProbeCount": 3,
  "Type": "ICMP_ECHO",
  "ProbeTimeout": 1000,
  "HcInstanceId": "hc-1k4ucuq77b56x4****",
  "RttThreshold": 300,
  "ProbeInterval": 2000,
  "SmartAGId": "sag-1um5x5nwhilymw****",
  "RttFailThreshold": 3,
  "DstIpAddr": "192.XX.XX.1"
}

Error codes

HTTP status codeError codeError messageDescription
400HC.InstanceNoFoundThe specified network health check instance does not exist.The specified network health check instance does not exist.

For a list of error codes, visit the Service error codes.