You can call the DescribeHealthStatus API to query the health status of a backend server.


Click here to perform a debug operation in OpenAPI Explorer and automatically generate an SDK code example.

Request parameters

Name Type Required? Example value Description
Action String Yes DescribeHealthStatus

The action to perform. Valid value: DescribeHealthStatus

LoadBalancerId String Yes lb-bp1qjwo61pqz3ahltv0mw

The ID of the SLB instance

RegionId String Yes cn-hangzhou

The ID of the region to which the SLB instance belongs

ListenerPort Integer No 80

The frontend port used by the SLB instance.

Valid values: 1–65535

Note If you do not set this parameter, the health check status of all ports is returned.

Response parameters

Name Type Example value Description

A list of backend servers

  └ServerId String vm-234

The ECS instance ID or ENI ID

  └ServerHealthStatus String abnormal

The health status of a backend server:

  • normal: The backend server is healthy.
  • abnormal: The backend server is unhealthy.
  • unavailable: The health check is not completed.
  └EniHost String

The IP address of the ENI

  └ListenerPort Integer 80

The frontend port used by the SLB instance

  └Port Integer 70

The backend port used by the SLB instance

  └ServerIp String

The IP address of the ECS instance

  └Type String ecs

The backend server type. Valid values:

  • ecs: ECS instance (default)
  • eni: Elastic Network Interface (ENI)
RequestId String 365F4154-92F6-4AE4-92F8-7FF34B540710

The ID of the request


Request example

http(s)://[Endpoint]/? Action=DescribeHealthStatus

Normal response examples

XML format


JSON format


Error codes

Click here to view the error codes.