DescribeHealthStatus - Developer Guide| Alibaba Cloud Documentation Center

Description

Query the health status of the backend servers.

Request parameter

Name	Type	Required	Description
Action	String	Yes	The action to perform. Valid value: `DescribeHealthStatus`
RegionId	String	Yes	The ID of the region where the SLB instance is located.
LoadBalancerId	String	Yes	The ID of the SLB instance.
ListenerPort	Integer	No	The front-end port of the listener. Valid value: [1,65535] Note: If no port is specified, the health check of all the listeners are returned.

Response parameter

Name	Type	Description
RequestId	String	The ID of the request.
LoadBalancerId	String	The ID of the Server Load Balancer instance.
BackendServers	JSON String	The list of the backend servers containing the following: `ServerId`: The ID of the ECS instance. `ServerHealthStatus`: The status of the backend server: `normal`: The status of the backend server is healthy. `abnormal`: The status of the backend server is unhealthy. `unavailable`: The status of the backend server cannot be obtained now. Maybe the health check has not be finished or the listener does not configure the health check.

Example

Request example

https://slb.aliyuncs.com/?Action=DescribeHealthStatus
&LoadBalancerId=139a00604ad-cn-east-hangzhou-01
&ListenerPort=80
&<CommonParameters>

Response example

XML format

<?xml version="1.0" encoding="UTF-8"?>
<DescribeHealthStatusResponse>
<RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
  <BackendServers>
      <BackendServer>
          <ServerId>vm-233</ServerId>
          <ServerHealthStatus>normal</ServerHealthStatus>
      </BackendServer>
      <BackendServer>
          <ServerId>vm-234</ServerId>
          <ServerHealthStatus>abnormal</ServerHealthStatus>
      </BackendServer>
</BackendServers>
</DescribeHealthStatusResponse>

JSON format

{
  "RequestId":"365F4154-92F6-4AE4-92F8-7FF34B540710",
  "LoadBalancerId":"139a00604ad-cn-east-hangzhou-01",
  "BackendServers":{
      "BackendServer": [
      {"ServerId": "vm-233", "ServerHealthStatus:"normal"},
      {"ServerId": "vm-234", "ServerHealthStatus:"abnormal"}
      ]
  }
}