All Products
Search
Document Center

Smart Access Gateway:DescribeHealthChecks

Last Updated:Mar 03, 2024

Queries health checks that are associated with a Smart Access Gateway (SAG) 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 region ID of the SAG instance.

cn-shanghai
SmartAGIdstringYes

The ID of the SAG instance.

sag-qi0p07ld5q86k3****
HcInstanceIdstringNo

The ID of the health check.

hc-ifflm5ygj3diwiu****
NamestringNo

The name of the health check.

The name must be 2 to 100 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

ddd3333
PageNumberintegerNo

The number of the page to return. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Default value: 10. Maximum value: 50.

10

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of entries returned.

5
PageSizeinteger

The number of entries returned per page. Default value: 10. Maximum value: 50.

10
RequestIdstring

The ID of the request.

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

The page number of the returned page. Default value: 1.

1
HealthChecksobject []

An array that consists of details about the health checks.

Typestring

The type of the packet used in the health check. Only ICMP_ECHO is supported.

ICMP_ECHO
ProbeTimeoutinteger

The timeout period of a probe.

Valid values: 10 to 30000.

Default value: 1000.

Unit: milliseconds.

1000
Statusstring

The status of the health check. Valid values:

  • success: The health check was successful.
  • failed: The health check failed.
  • unknown: The health check was not started.
unknown
DstIpAddrstring

The destination IP address of the health check.

110.XX.XX.1
RelationCountinteger

The number of routes that are associated with the health check.

3
RttFailThresholdinteger

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.

3
SmartAGIdstring

The ID of the SAG instance.

sag-qi0p07ld5q86k3****
DstPortinteger

The destination port of the health check.

Note This feature is not supported.
33
FailCountThresholdinteger

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

Valid values: 1 to 15.

Default value: 3.

3
RttThresholdinteger

The maximum RTT.

Valid values: -1 and 1 to 5000.

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

Unit: milliseconds.

45
SrcPortinteger

The source port of the health check.

Note This feature is not supported.
334
ProbeCountinteger

The number of probes performed per health check.

Valid values: 1 to 20.

Default value: 1.

2
Descriptionstring

The description of the health check.

Health Check
SrcIpAddrstring

The source IP address of the health check.

192.XX.XX.1
ProbeIntervalinteger

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.

2000
Namestring

The name of the health check.

doctest
HcInstanceIdstring

The ID of the health check.

hc-ifflm5ygj3diwi****

Examples

Sample success responses

JSONformat

{
  "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": "Health Check",
        "SrcIpAddr": "192.XX.XX.1",
        "ProbeInterval": 2000,
        "Name": "doctest",
        "HcInstanceId": "hc-ifflm5ygj3diwi****"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400SAG.InstanceIdEmptyYou must specify the SAG instance ID.You must specify the SAG instance ID.
400SAG.InstanceNoFoundThe specified SAG instance does not exist.The specified SAG instance does not exist.

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