All Products
Search
Document Center

Server Load Balancer:DescribeHealthStatus

Last Updated:Mar 01, 2024

Queries the health status of backend servers.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
slb:DescribeHealthStatusREAD
  • loadbalancer
    acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}
  • slb:tag
none

Request parameters

ParameterTypeRequiredDescriptionExample
LoadBalancerIdstringYes

The ID of the Classic Load Balancer (CLB) instance.

lb-bp1qjwo61pqz3ah****
ListenerPortintegerNo

The frontend port that is used by the CLB instance.

Valid values: 1 to 65535.

Note If you do not specify this parameter, the health status of all ports is returned.
80
ListenerProtocolstringNo

The frontend protocol that is used by the CLB instance.

https
RegionIdstringNo

The ID of the region where the CLB instance is deployed.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

365F4154-92F6-4AE4-92F8-7FF34B540710
BackendServersobject []

The list of backend servers.

ServerHealthStatusstring

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 complete.
abnormal
Protocolstring

The frontend protocol that is used by the CLB instance.

https
ListenerPortinteger

The frontend port that is used by the CLB instance.

80
ServerIpstring

The IP address of the ECS instance.

192.XX.XX.11
Portinteger

The backend port that is used by the CLB instance.

70
ServerIdstring

The ID of the Elastic Compute Service (ECS) instance or elastic network interface (ENI).

i-bp1h5u3fv54ytf***

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
400TooManyListenersMore than 1 listener is found, please be more specified.

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

Change history

Change timeSummary of changesOperation
2023-09-08The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change