tencent cloud

Application Load Balancer

DocumentationApplication Load BalancerAPI DocumentationListener APIsDescribeListenerDetail

DescribeListenerDetail

Download
Focus Mode
Font Size
Last updated: 2026-09-28 14:17:52

1. API Description

Domain name for API request: alb.intl.tencentcloudapi.com.

Queries details of one listener.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: DescribeListenerDetail.
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.

3. Output Parameters

Parameter Name Type Description
CaCertificateIds Array of String

List of CA certificate IDs bound to the listener.
CaEnabled Boolean

Whether to enable mutual authentication.
CertificateIds Array of String

List of server certificate IDs.
CreateTime Timestamp ISO8601

Creation time of the listener instance. Format: ISO 8601 (for example, 2025-01-01T08:30:00+08:00)
DefaultActions Array of DefaultAction

Action list of the rule.
GzipEnabled Boolean

Whether to enable Gzip compression.
Http2Enabled Boolean

Whether to enable the HTTP/2 feature.
IdleTimeout Integer

Specify the connection idle timeout period. Unit: seconds.
ListenerId String

Listener ID, in the format of lst- followed by 8 alphanumeric characters.
ListenerName String

Custom listener name.
ListenerPort Integer

Port used by the load balancing instance frontend.
ListenerProtocol String

Listening protocol.
ListenerStatus String

Listener status. Value range:

  • Active: running.
  • Provisioning: under creation.
  • Configuring: changing.
  • ProvisionFailed: creation failed
LoadBalancerId String

Cloud Load Balancer instance ID. The format is alb- followed by 8 alphanumeric characters.
ModifyTime Timestamp ISO8601

Last change time of the listener instance. Format: ISO 8601 (for example, 2025-01-01T08:30:00+08:00)
RequestTimeout Integer

Connection request timeout period. Unit: seconds.
SecurityPolicyId String

Security policy ID, format: tls- followed by 8 alphanumeric characters.
Tags Array of TagInfo

Tag.
XForwardedForConfig XForwardedForConfig

XForwardedFor configuration.
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.

4. Example

Example1 Query listener details

Input Example

POST / HTTP/1.1
Host: alb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeListenerDetail
<Common request parameters>

{
    "LoadBalancerId": "alb-f8q2xk9m",
    "ListenerId": "lst-d9p3k7wa"
}

Output Example

{
    "Response": {
        "LoadBalancerId": "alb-f8q2xk9m",
        "ListenerId": "lst-d9p3k7wa",
        "ListenerName": "443",
        "ListenerPort": 80,
        "ListenerProtocol": "HTTPS",
        "ListenerStatus": "Active",
        "CertificateIds": [
            "Fm8Wp7x8"
        ],
        "CaCertificateIds": [],
        "GzipEnabled": false,
        "CaEnabled": false,
        "Http2Enabled": false,
        "SecurityPolicyId": "tls-t2ckydug",
        "IdleTimeout": 15,
        "RequestTimeout": 60,
        "XForwardedForConfig": {
            "XForwardedForMode": "append",
            "XForwardedForProtoEnabled": false,
            "XForwardedForPortEnabled": false,
            "XForwardedForHostEnabled": false,
            "XForwardedForClientSrcPortEnabled": false,
            "XTencentClientSDNEnabled": false,
            "XTencentClientIDNEnabled": false,
            "XTencentClientSerialEnabled": false,
            "XTencentClientVerifyEnabled": false
        },
        "DefaultActions": [
            {
                "Type": "TargetGroup",
                "TargetGroupConfig": {
                    "TargetGroups": [
                        {
                            "TargetGroupId": "lbtg-0zrnc9qa",
                            "Weight": 10
                        }
                    ]
                }
            }
        ],
        "Tags": [],
        "RequestId": "cb7e17c7-9e71-42d2-9fa6-ed98bef10c93"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Previous Topic: DescribeListenerHealthStatusNext Topic: DescribeListenerCertificates

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback

Search
    Enter keywords to search documentation