DescribeHealthCheckAttribute - Smart Access Gateway - Alibaba Cloud Documentation Center

Queries the detailed information about a health check instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
smartag:DescribeHealthCheckAttribute	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Smart Access Gateway (SAG) instance.	cn-shanghai
HcInstanceId	string	Yes	The ID of the health check instance.	hc-1k4ucuq77b56x4****
SmartAGId	string	Yes	The ID of the SAG instance.	sag-1um5x5nwhilymw****

Response parameters

Parameter	Type	Description	Example
	object
SrcPort	integer	The source port of the health check instance. Note This feature is not supported.	2334
Description	string	The description of the health check instance.	hc-123
RequestId	string	The ID of the request.	DDA08B78-5634-4A83-94E4-5C58FD7EBA19
SrcIpAddr	string	The source IP address of the health check.	10.XX.XX.1
CreateTime	long	The time when the health check instance was created. This value is a UNIX timestamp. Unit: milliseconds.	1586759657000
FailCountThreshold	integer	The maximum number of failed probes before the health check is declared failed. Valid values: 1 to 15. Default value: 3.	3
DstPort	integer	The destination port of the health check instance. Note This feature is not supported.	1223
Name	string	The name of the health check instance.	bvt-test-03****
ProbeCount	integer	The number of probes performed per health check. Valid values: 1 to 20. Default value: 1.	3
Type	string	The type of packets used in the health check. Only ICMP_ECHO is supported.	ICMP_ECHO
ProbeTimeout	integer	The timeout period of the probe. Valid values: 10 to 30000. Default value: 1000. Unit: milliseconds.	1000
HcInstanceId	string	The ID of the health check instance.	hc-1k4ucuq77b56x4****
RttThreshold	integer	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.	300
ProbeInterval	integer	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
SmartAGId	string	The ID of the SAG instance.	sag-1um5x5nwhilymw****
RttFailThreshold	integer	The number of times that the maximum RTT is exceeded before an alert is triggered. Valid values: 1 to 15. Default value: 3.	3
DstIpAddr	string	The destination IP address of the health check.	192.XX.XX.1

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 code	Error code	Error message	Description
400	HC.InstanceNoFound	The 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.