Help & DocumentationAPIsGlobal Application Acceleration PlatformListener APIsDescribeTCPListeners

DescribeTCPListeners

Last updated: 2019-11-25 22:39:41

Contents：

1. API Description

Domain name for API request: gaap.tencentcloudapi.com.

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.

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 a TCP Listener List

Query a TCP listener list.

Input Example

https://gaap.tencentcloudapi.com/?Action=DescribeTCPListeners
&ProxyId=link-hwera8lq
&ListenerId=listener-gkzl9e7t
&<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,
        "RealServerList": [
          {
            "RealServerWeight": 1,
            "RealServerId": "rs-d2rwammv",
            "RealServerPort": 111,
            "RealServerIP": "a.a.com",
            "RealServerStatus": -1,
            "DownIPList": [
              "11.11.11.11:111"
            ]
          }
        ]
      }
    ],
    "RequestId": "38fab584-8d14-4e2c-988c-4acdabbf2dff"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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
InvalidParameterValue Parameter value error
MissingParameter Parameter missing
ResourceNotFound Resource does not exist
UnauthorizedOperation Unauthorized operation
UnknownParameter Unknown parameter error