DescribeHealthStatus - Server Load Balancer - Alibaba Cloud Documentation Center

Queries the health status of backend servers.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

slb:DescribeHealthStatus

get

*loadbalancer

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

slb:tag
slb:tag
slb:tag
slb:tag
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.	http
RegionId	string	No	The region ID of the SLB instance.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	365F4154-92F6-4AE4-92F8-7FF******
BackendServers	object
BackendServer	array<object>	The backend servers.
	object	The backend servers.
Protocol	string	The frontend protocol that is used by the SLB instance.	http
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.	80
ServerId	string	The ID of the backend server.	i-bp1h5u3fv54ytf***

Examples

Success response

JSON format

{
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF******",
  "BackendServers": {
    "BackendServer": [
      {
        "Protocol": "http",
        "ServerHealthStatus": "abnormal",
        "ListenerPort": 80,
        "ServerIp": "192.XX.XX.11",
        "Port": 80,
        "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.	System Busy

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.