Domain name for API request: alb.intl.tencentcloudapi.com.
Queries the listener list
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: DescribeListeners. |
| 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. |
| LoadBalancerId | Yes | String | Cloud Load Balancer instance ID, in the format of "alb-" followed by 8 alphanumeric characters. |
| Filters.N | No | Array of Filter | Filter criteria list. Supports up to 20. Supports the following fields. - Protocol: Protocol type - Tags: Tag |
| ListenerIds.N | No | Array of String | Listener ID list. ID format: lst- followed by 8 alphanumeric characters. |
| MaxResults | No | Integer | Maximum number of data records read this time. Value: 1-100. Default value: 20 |
| NextToken | No | String | Token for the next query. If it is empty, this queries page 1. |
| Parameter Name | Type | Description |
|---|---|---|
| Listeners | Array of ListenerOutput | Listener information. |
| LoadBalancerId | String | CLB instance ID. The format is alb- followed by 8 alphanumeric characters. |
| MaxResults | Integer | Maximum number of data records read this time. |
| NextToken | String | Token for the next query. |
| TotalCount | Integer | Total number of entries. |
| 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: DescribeListeners
<Common request parameters>
{
"LoadBalancerId": "alb-f8q2xk9m",
"MaxResults": 10
}{
"Response": {
"LoadBalancerId": "alb-f8q2xk9m",
"Listeners": [
{
"ListenerId": "lst-d9p3k7wa",
"ListenerName": "443",
"ListenerProtocol": "HTTPS",
"ListenerPort": 80,
"ListenerStatus": "Active",
"GzipEnabled": false,
"Http2Enable": false,
"CaEnable": false,
"RequestTimeout": 60,
"IdleTimeout": 15,
"TlsSecurityPolicyId": "tls-t2ckydug",
"XForwardedForConfig": {
"XForwardedForMode": "append",
"XForwardedForProtoEnabled": false,
"XForwardedForPortEnabled": false,
"XForwardedForHostEnabled": false,
"XForwardedForClientSrcPortEnabled": false,
"XTencentClientSDNEnabled": false,
"XTencentClientIDNEnabled": false,
"XTencentClientSerialEnabled": false,
"XTencentClientVerifyEnabled": false
},
"Tags": []
}
],
"TotalCount": 1,
"MaxResults": 1,
"NextToken": "",
"RequestId": "1d92eab2-8e5b-4c29-b1b8-4454479c7196"
}
}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.
フィードバック