tencent cloud

DescribeListeners
下载PDF
最后更新时间：2025-11-25 10:11:22
DescribeListeners
最后更新时间： 2025-11-25 10:11:22
下载PDF

1. API Description

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

This API is used to get the list of listeners by CLB ID, listener protocol, or listener port. If no filter is specified, all listeners for the CLB instance will be returned.

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: DescribeListeners.
Version Yes String Common Params. The value used for this API: 2018-03-17.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
LoadBalancerId Yes String ID of the cloud load balancer instance. you can call the DescribeLoadBalancers api to obtain the ID.
ListenerIds.N No Array of String Specifies the array of clb listener ids to query, with a maximum of 100. you can call the DescribeListeners api to obtain the ids.
Protocol No String Type of the listener protocols to be queried. Values: TCP,UDP,HTTP,HTTPS,TCP_SSLandQUIC`.
Port No Integer Port of listener to query. value range: 1-65535.

3. Output Parameters

Parameter Name Type Description
Listeners Array of Listener Listener list
TotalCount Integer Total number of listeners (filtered by port, protocol, and listener ID).
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 Querying Listeners by Port, Protocol, and Listener ID

Input Example

https://clb.intl.tencentcloudapi.com/?Action=DescribeListeners
&LoadBalancerId=lb-aniq7ewx
&Protocol=TCP
&Port=333
&ListenerIds.0=lbl-hd9nfp6o
&<Common request parameters>

Output Example

{
    "Response": {
        "TotalCount": 1,
        "Listeners": [
            {
                "ListenerId": "lbl-hd9nfp6o",
                "ListenerName": "TCP-Listener",
                "CreateTime": "2020-12-31 12:03:36",
                "Protocol": "TCP",
                "Port": 333,
                "EndPort": 0,
                "HealthCheck": {
                    "HealthSwitch": 1,
                    "TimeOut": 2,
                    "IntervalTime": 5,
                    "HealthNum": 3,
                    "UnHealthNum": 3,
                    "CheckPort": null,
                    "CheckType": "TCP",
                    "HttpCheckDomain": null,
                    "HttpCheckPath": null,
                    "HttpCheckMethod": null,
                    "HttpVersion": null,
                    "HttpCode": null,
                    "ContextType": null,
                    "SendContext": null,
                    "RecvContext": null,
                    "ExtendedCode": null,
                    "SourceIpType": 0
                },
                "Certificate": null,
                "Scheduler": "WRR",
                "SessionExpireTime": 0,
                "SniSwitch": 0,
                "Rules": null,
                "TargetType": "NODE",
                "TargetGroup": null,
                "KeepaliveEnable": null,
                "SessionType": "NORMAL",
                "Toa": false,
                "DeregisterTargetRst": false,
                "MaxConn": 100,
                "MaxCps": 100,
                "IdleConnectTimeout": 0,
                "AttrFlags": [
                    "Stop"
                ],
                "TargetGroupList": null
            }
        ],
        "RequestId": "3ddae670-4a89-4919-af6e-0d6bf195c92e"
    }
}

Example2 Querying the Information of All Listeners of a CLB Instance

Input Example

https://clb.intl.tencentcloudapi.com/?Action=DescribeListeners
&LoadBalancerId=lb-aniq7ewx
&<Common request parameters>

Output Example

{
    "Response": {
        "TotalCount": 1,
        "Listeners": [
            {
                "ListenerId": "lbl-hd9nfp6o",
                "ListenerName": "TCP-Listener",
                "CreateTime": "2020-12-31 12:03:36",
                "Protocol": "TCP",
                "Port": 333,
                "EndPort": 0,
                "HealthCheck": {
                    "HealthSwitch": 1,
                    "TimeOut": 2,
                    "IntervalTime": 5,
                    "HealthNum": 3,
                    "UnHealthNum": 3,
                    "CheckPort": null,
                    "CheckType": "TCP",
                    "HttpCheckDomain": null,
                    "HttpCheckPath": null,
                    "HttpCheckMethod": null,
                    "HttpVersion": null,
                    "HttpCode": null,
                    "ContextType": null,
                    "SendContext": null,
                    "RecvContext": null,
                    "ExtendedCode": null,
                    "SourceIpType": 0
                },
                "Certificate": null,
                "Scheduler": "WRR",
                "SessionExpireTime": 0,
                "SniSwitch": 0,
                "Rules": null,
                "TargetType": "NODE",
                "TargetGroup": null,
                "KeepaliveEnable": null,
                "SessionType": "NORMAL",
                "Toa": false,
                "DeregisterTargetRst": false,
                "MaxConn": 100,
                "MaxCps": 100,
                "IdleConnectTimeout": 0,
                "AttrFlags": [
                    "Stop"
                ],
                "TargetGroupList": null
            }
        ],
        "RequestId": "3ddae670-4a89-4919-af6e-0d6bf195c92e"
    }
}

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

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameter.FormatError Wrong parameter format.
InvalidParameter.LBIdNotFound Wrong CLB instance ID.
InvalidParameter.RegionNotFound Invalid region.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.InvalidFilter Incorrect Filter parameter.
InvalidParameterValue.Length Wrong parameter length.
UnauthorizedOperation Unauthorized operation.
本页内容是否解决了您的问题？
您也可以 联系销售 或 提交工单 以寻求帮助。
是
否

文档反馈