tencent cloud

Feedback

DescribeListeners

Last updated: 2022-05-19 15:57:46

1. API Description

Domain name for API request: clb.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 CLB instance ID.
ListenerIds.N No Array of String Array of CLB listener IDs to query (100 IDs at most).
Protocol No String Type of the listener protocols to be queried. Valid values: TCP, UDP, HTTP, HTTPS, and TCP_SSL.
Port No Integer Port of the listeners to be queried

3. Output Parameters

Parameter Name Type Description
Listeners Array of Listener Listener list
TotalCount Integer Total number of listeners (with filters of port, protocol, and listener ID applied).
Note: This field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the information of all listeners in a CLB instance

Input Example

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

Output Example

{
  "Response": {
    "TotalCount": 3,
    "Listeners": [
      {
        "ListenerId": "lbl-2ytsji1u",
        "ListenerName": "555",
        "CreateTime": "2020-12-31 11:36:18",
        "Protocol": "HTTP",
        "Port": 555,
        "EndPort": 0,
        "HealthCheck": null,
        "Certificate": null,
        "Scheduler": null,
        "SessionExpireTime": null,
        "SniSwitch": 0,
        "Rules": [
          {
            "ListenerId": "lbl-2ytsji1u",
            "LocationId": "loc-nq5fuotq",
            "Domain": "www.123.com",
            "Url": "/123",
            "CreateTime": "2020-12-31 11:36:48",
            "Certificate": null,
            "HealthCheck": {
              "HealthSwitch": 1,
              "TimeOut": 5,
              "IntervalTime": 5,
              "HealthNum": 3,
              "UnHealthNum": 3,
              "HttpCode": 15,
              "HttpCheckPath": "/",
              "HttpCheckDomain": "www.123.com",
              "HttpCheckMethod": "get",
              "CheckPort": null,
              "CheckType": "TCP",
              "HttpVersion": null,
              "ContextType": null,
              "SendContext": null,
              "RecvContext": null
            },
            "RewriteTarget": {
              "TargetListenerId": null,
              "TargetLocationId": null,
              "RewriteCode": null,
              "TakeUrl": null,
              "RewriteType": null
            },
            "SessionExpireTime": 0,
            "Scheduler": "WRR",
            "HttpGzip": true,
            "BeAutoCreated": false,
            "DefaultServer": true,
            "Http2": false,
            "ForwardType": "HTTP",
            "TargetType": "NODE",
            "TargetGroup": null,
            "WafDomainId": "",
            "TrpcCallee": "",
            "TrpcFunc": "",
            "QuicStatus": "OFF"
          }
        ],
        "TargetType": null,
        "TargetGroup": null,
        "KeepaliveEnable": 0,
        "SessionType": "NORMAL",
        "Toa": false,
        "DeregisterTargetRst": false
      },
      {
        "ListenerId": "lbl-a459zzae",
        "ListenerName": "222",
        "CreateTime": "2020-12-10 20:26:54",
        "Protocol": "HTTP",
        "Port": 222,
        "EndPort": 0,
        "HealthCheck": null,
        "Certificate": null,
        "Scheduler": null,
        "SessionExpireTime": null,
        "SniSwitch": 0,
        "Rules": [
          {
            "ListenerId": "lbl-a459zzae",
            "LocationId": "loc-7pbxg3d4",
            "Domain": "www.123.com",
            "Url": "/",
            "CreateTime": "2020-12-10 20:33:14",
            "Certificate": null,
            "HealthCheck": {
              "HealthSwitch": 1,
              "TimeOut": 5,
              "IntervalTime": 5,
              "HealthNum": 3,
              "UnHealthNum": 3,
              "HttpCode": 15,
              "HttpCheckPath": "/",
              "HttpCheckDomain": "www.123.com",
              "HttpCheckMethod": "get",
              "CheckPort": null,
              "CheckType": "TCP",
              "HttpVersion": null,
              "ContextType": null,
              "SendContext": null,
              "RecvContext": null
            },
            "RewriteTarget": {
              "TargetListenerId": null,
              "TargetLocationId": null,
              "RewriteCode": null,
              "TakeUrl": null,
              "RewriteType": null
            },
            "SessionExpireTime": 0,
            "Scheduler": "WRR",
            "HttpGzip": true,
            "BeAutoCreated": false,
            "DefaultServer": true,
            "Http2": false,
            "ForwardType": "HTTP",
            "TargetType": "NODE",
            "TargetGroup": null,
            "WafDomainId": "",
            "TrpcCallee": "",
            "TrpcFunc": "",
            "QuicStatus": "OFF"
          }
        ],
        "TargetType": null,
        "TargetGroup": null,
        "KeepaliveEnable": 0,
        "SessionType": "NORMAL",
        "Toa": false,
        "DeregisterTargetRst": false
      }
    ],
    "RequestId": "2682e290-3f8c-4766-98fa-716610e2d351"
  }
}

Example2 Querying listeners by port, protocol, and listener ID

Input Example

https://clb.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": "12345",
        "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
        },
        "Certificate": null,
        "Scheduler": "WRR",
        "SessionExpireTime": 0,
        "SniSwitch": 0,
        "Rules": null,
        "TargetType": "NODE",
        "TargetGroup": null,
        "KeepaliveEnable": null,
        "SessionType": "NORMAL",
        "Toa": false,
        "DeregisterTargetRst": false
      }
    ],
    "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.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.InvalidFilter Incorrect Filter parameter.
InvalidParameterValue.Length Wrong parameter length.
UnauthorizedOperation Unauthorized operation.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support