Queries the health status of one or more backend servers.
Debug
Use OpenAPI Explorer to perform debug operations and generate SDK code examples.
Request parameters
Parameter | Type | Required? | Example value | Description |
---|---|---|---|---|
Action | String | Yes | DescribeHealthStatus |
The name of this action. Value: DescribeHealthStatus |
LoadBalancerId | String | Yes | lb-bp1qjwo61pqz3ahltv0mw |
The ID of the SLB instance. |
RegionId | String | Yes | cn-hangzhou-d |
The ID of the region to which the SLB instance belongs. |
ListenerPort | Integer | No | 80 |
Optional. The frontend port used by the SLB instance. Value range: 1 to 65535 Note If you do not set this parameter, the health check status of all ports is returned.
|
ListenerProtocol | String | No | https |
Optional. The frontend protocol used by the SLB instance. |
Response parameters
Parameter | Type | Example value | Description |
---|---|---|---|
BackendServers |
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:
|
└EniHost | String | 192.168.0.1 |
The IP address of an ENI. |
└ListenerPort | Integer | 80 |
The frontend port used by the SLB instance. |
└Port | Integer | 70 |
The backend port used by the SLB instance. |
└Protocol | String | https |
The frontend protocol used by the SLB instance. |
└ServerIp | String | 192.168.0.2 |
The IP address of an ECS instance. |
└Type | String | ecs |
The backend server type. Valid values:
|
RequestId | String | 365F4154-92F6-4AE4-92F8-7FF34B540710 |
The ID of the request. |
Examples
Request example
http(s)://[Endpoint]/? Action=DescribeHealthStatus
&LoadBalancerId=lb-bp1qjwo61pqz3ahltv0mw
&<CommonParameters>
Response examples
XML
format
<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":"196EC328-B566-4226-B435-8697723205EF",
"BackendServers":{
"BackendServer":[
{
"ServerId":"i-bp1do02x7n4nua4k72um",
"ServerHealthStatus":"abnormal",
"Port":80,
"ListenerPort":443
}
]
}
}