Domain name for API request: alb.intl.tencentcloudapi.com.
Queries the health status of a listener.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeListenerHealthStatus. |
| Version | Yes | String | Common Params. The value used for this API: 2025-10-30. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| ListenerId | Yes | String | Listener ID, in the format of lst- followed by 8 alphanumeric characters. |
| LoadBalancerId | Yes | String | Cloud Load Balancer instance ID. The format is alb- followed by 8 alphanumeric characters. |
| IncludeRule | No | Boolean | Whether the health check result contains forwarding rules. If false, only return the health status of the default forwarding rule. If true, return the health status of all rules (including the default rule). Valid values: true: yes false (default value): no. |
| MaxResults | No | Integer | Maximum number of data records read this time. Value: 1-100. Default value: 20 |
| NextToken | No | String | Token for querying the next page. Not required for the first query. |
| Parameter Name | Type | Description |
|---|---|---|
| ListenerId | String | Listener ID, format: lst- followed by 8 alphanumeric characters. |
| ListenerPort | String | Listener port. |
| ListenerProtocol | String | Listener protocol. |
| NextToken | String | Token for the next query. If it is empty, this is the last page. |
| RuleHealthStatusInfos | Array of RuleHealthStatusInfo | Health status of the forwarding rule. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: alb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeListenerHealthStatus
<Common request parameters>
{
"IncludeRule": false,
"ListenerId": "lst-d9p3k7wa",
"LoadBalancerId": "alb-f8q2xk9m",
"MaxResults": 20
}{
"Response": {
"ListenerId": "lst-d9p3k7wa",
"ListenerPort": "80",
"ListenerProtocol": "HTTP",
"NextToken": "2c44874464923a9f",
"RuleHealthStatusInfos": [
{
"IsDefaultRule": "false",
"RuleId": "rule-h8cy5gwl",
"TargetGroupHealthInfos": [
{
"HealthCheckEnabled": true,
"TargetGroupId": "lbtg-0zrnc9qa",
"TargetHealthStatusInfos": [
{
"Status": "Healthy",
"TargetId": "ins-x8q2m4pa",
"TargetIp": "10.0.0.1",
"TargetPort": 80
}
],
"Type": "TargetGroup"
}
]
}
],
"RequestId": "3b848733-70e5-4558-ae39-4b9938eb7609"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback