DescribeHealthStatus

Description

call the DescribeHealthStatus to query the health status of the backend server.

Request Method

POST

Request Path

/apsara/route/Slb/DescribeHealthStatus

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
ListenerPort	BODY	integer	No	80	the port used by the front end of the load balancing instance. value:1~65535 Description If this parameter is not set, it means that the health check status of all ports is obtained.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
LoadBalancerId	BODY	string	Yes	lb-bp1qjwo61pqz3ah****	load balancing instance ID.
RegionId	BODY	string	Yes	cn-hangzhou	the region ID of the load balancing instance.
version	BODY	string	No	2016-01-01	version of api

Return data

Name	Type	Sample value	Description
ListenerPort	integer	80	the port used by the front end of the load balancing instance.
ServerId	string	i-bp1h5u3fv54ytf****	ECS instance ID or ENI instance ID.
RequestId	string	365F4154-92F6-4AE4-92F8-7FF34B540710	request ID.
BackendServer		No sample value for this parameter.	No description for this parameter.
port	integer	80	No description for this parameter.
ServerHealthStatus	string	abnormal	the health status of the backend server. normal: backend server health. abnormal: the backend server is unhealthy. unavailable: health check has not been completed.
BackendServers	array of backendserver	No sample value for this parameter.	backend server list.

Example

Successful Response example

{
 "ListenerPort":"80",
 "ServerId":"i-bp1h5u3fv54ytf****",
 "RequestId":"365F4154-92F6-4AE4-92F8-7FF34B540710",
 "BackendServer":"",
 "port":"80",
 "ServerHealthStatus":"abnormal",
 "BackendServers":""
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}