Last updated: 2021-04-12 11:42:01

1. API Description

Domain name for API request:

This API (DescribeTCPListeners) is used to query the TCP listener information of a single connection or connection group.

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 parameter. The value used for this API: DescribeTCPListeners.
Version Yes String Common parameter. The value used for this API: 2018-05-29.
Region No String Common parameter. This parameter is not required for this API.
ProxyId No String Connection ID; Either ProxyId or GroupId must be set, but you cannot set both.
ListenerId No String Filter condition. Exact query by listener IDs.
ListenerName No String Filter condition. Exact query by listener names.
Port No Integer Filter condition. Exact query by listener ports.
Offset No Integer Offset. The default value is 0.
Limit No Integer Quantity limit. The default value is 20.
GroupId No String Connection group ID; Either ProxyId or GroupId must be set, but you cannot set both.
SearchValue No String Filter condition. It supports fuzzy query by ports or listener names. This parameter cannot be used with ListenerName or Port.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total quantity of listeners that matches the conditions
ListenerSet Array of TCPListener TCP listener list
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying TCP listener list

This example shows you how to query the TCP listener list.

Input Example
&<Common request parameters>

Output Example

  "Response": {
    "TotalCount": 2,
    "ListenerSet": [
        "HealthCheck": 1,
        "Protocol": "TCP",
        "ListenerId": "listener-gkzl9e7t",
        "Port": 111,
        "RealServerType": "IP",
        "RealServerPort": null,
        "DelayLoop": 30,
        "BindStatus": 0,
        "Scheduler": "rr",
        "ListenerStatus": 0,
        "ListenerName": "111",
        "ConnectTimeout": 2,
        "ClientIPMethod": 1,
        "CreateTime": 1607071157,
        "RealServerSet": [
            "RealServerWeight": 1,
            "RealServerId": "rs-d2rwammv",
            "RealServerPort": 111,
            "RealServerIP": "",
            "RealServerStatus": -1,
            "DownIPList": [
    "RequestId": "38fab584-8d14-4e2c-988c-4acdabbf2dff"

5. Developer Resources


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
AuthFailure.NotEnterpriseAuthorization Not an organizational customer.
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
MissingParameter Missing parameter.
ResourceNotFound The resource does not exist.
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback