edit-icon download-icon

DescribeHealthStatus

Last Updated: Apr 04, 2018

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

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

Response example

  • XML format

    1. <?xml version="1.0" encoding="UTF-8"?>
    2. <DescribeHealthStatusResponse>
    3. <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
    4. <BackendServers>
    5. <BackendServer>
    6. <ServerId>vm-233</ServerId>
    7. <ServerHealthStatus>normal</ServerHealthStatus>
    8. </BackendServer>
    9. <BackendServer>
    10. <ServerId>vm-234</ServerId>
    11. <ServerHealthStatus>abnormal</ServerHealthStatus>
    12. </BackendServer>
    13. </BackendServers>
    14. </DescribeHealthStatusResponse>
  • JSON format

    1. {
    2. "RequestId":"365F4154-92F6-4AE4-92F8-7FF34B540710",
    3. "LoadBalancerId":"139a00604ad-cn-east-hangzhou-01",
    4. "BackendServers":{
    5. "BackendServer": [
    6. {"ServerId": "vm-233", "ServerHealthStatus:"normal"},
    7. {"ServerId": "vm-234", "ServerHealthStatus:"abnormal"}
    8. ]
    9. }
    10. }
Thank you! We've received your feedback.