DescribeHealthStatus - Server Load Balancer - Alibaba Cloud Documentation Center

Queries the health status of backend servers.

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:
- The required resource types are displayed in bold characters.
- 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
slb:DescribeHealthStatus	get	loadbalancer acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}	slb:tag	none

Request parameters

Parameter	Type	Required	Description	Example
LoadBalancerId	string	Yes	The ID of the Classic Load Balancer (CLB) instance.	lb-bp1qjwo61pqz3ah****
ListenerPort	integer	No	The frontend port that is used by the SLB instance. Valid values: 1 to 65535. Note If you do not specify this parameter, the health status of all ports is returned.	80
ListenerProtocol	string	No	The frontend protocol that is used by the SLB instance.	https
RegionId	string	No	The region ID of the SLB instance.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	365F4154-92F6-4AE4-92F8-7FF34B540710
BackendServers	array<object>	The backend servers.
BackendServer	object	The backend servers.
Protocol	string	The frontend protocol that is used by the SLB instance.	https
ServerHealthStatus	string	The health status of the backend server. Valid values: normal: The backend server is healthy. abnormal: The backend server is unhealthy. unavailable: The health check is not completed.	abnormal
ListenerPort	integer	The frontend port that is used by the SLB instance.	80
ServerIp	string	The IP address of the backend server.	192.XX.XX.11
Port	integer	The backend port that is used by the SLB instance.	70
ServerId	string	The ID of the backend server.	i-bp1h5u3fv54ytf***

Examples

Sample success responses

JSONformat

{
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "BackendServers": {
    "BackendServer": [
      {
        "Protocol": "https",
        "ServerHealthStatus": "abnormal",
        "ListenerPort": 80,
        "ServerIp": "192.XX.XX.11",
        "Port": 70,
        "ServerId": "i-bp1h5u3fv54ytf***"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	TooManyListeners	More than 1 listener is found, please be more specified.	-
400	LocationServiceTimeout	Location service connection timeout. Please try again later.	-
400	SystemBusy	The system is busy.	The service is unavailable. Please try again later.

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

Change history

Change time	Summary of changes	Operation
2023-09-08	The Error code has changed	View Change Details