DescribeTCPListeners

Recent Pages

Last updated: 2021-10-08 15:10:58

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.

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

https://gaap.tencentcloudapi.com/?Action=DescribeTCPListeners
&ProxyId=link-hwera8lq
&ListenerId=listener-gkzl9e7t
&<Common request parameters>

Output Example

{
  "Response": {
    "TotalCount": 1,
    "ListenerSet": [
      {
        "HealthyThreshold": 1,
        "BindStatus": 1,
        "SessionPersist": 1,
        "RealServerType": "xx",
        "Protocol": "xx",
        "ConnectTimeout": 1,
        "RealServerPort": 1,
        "HealthCheck": 1,
        "ListenerId": "xx",
        "UnhealthyThreshold": 1,
        "ListenerStatus": 1,
        "ListenerName": "xx",
        "Scheduler": "xx",
        "ClientIPMethod": 1,
        "FailoverSwitch": 1,
        "RealServerSet": [
          {
            "RealServerStatus": 0,
            "RealServerPort": 111,
            "RealServerId": "xx",
            "DownIPList": [
              "11.11.11.11:111"
            ],
            "RealServerWeight": 1,
            "RealServerIP": "xx"
          }
        ],
        "CreateTime": 1,
        "Port": 1,
        "DelayLoop": 1
      }
    ],
    "RequestId": "xx"
  }
}

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

Tencent Cloud CLI 3.0

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.
ResourceUnavailable.AccountViolation	Restricted resources found in your account. Check your inbox and email for details.
UnauthorizedOperation	Unauthorized operation.
UnknownParameter	Unknown parameter.

Recent Pages