Documentation|Tencent Cloud

Recent Pages

Documentation

DescribeHTTPListeners

Last updated: 2020-07-24 15:09:17

1. API Description

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

This API (DescribeHTTPListeners) is used to query HTTP listener information.

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: DescribeHTTPListeners.
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
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.
SearchValue	No	String	Filter condition. It supports fuzzy query by ports or listener names. This parameter cannot be used with `ListenerName` or `Port`.
GroupId	No	String	Connection group ID

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Quantity of listeners
ListenerSet	Array of HTTPListener	HTTP 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 the HTTP Listener Information

Query the HTTP listener Information.

Input Example

https://gaap.tencentcloudapi.com/?Action=DescribeHTTPListeners
&ProxyId=link-n9ha8jzl
&Offset=0
&Limit=20
&<Common request parameters>

Output Example

{
  "Response": {
    "TotalCount": 4,
    "ListenerSet": [
      {
        "Protocol": "HTTP",
        "ListenerId": "listener-4e99n24b",
        "Port": 80,
        "ListenerStatus": 0,
        "ListenerName": "http80",
        "CreateTime": 1563335063
      },
      {
        "Protocol": "HTTP",
        "ListenerId": "listener-jmi21mrf",
        "Port": 8080,
        "ListenerStatus": 0,
        "ListenerName": "http8080",
        "CreateTime": 1564590945
      },
      {
        "Protocol": "HTTP",
        "ListenerId": "listener-1grazsz5",
        "Port": 18080,
        "ListenerStatus": 0,
        "ListenerName": "http18080",
        "CreateTime": 1564590963
      },
      {
        "Protocol": "HTTP",
        "ListenerId": "listener-l6z66uqb",
        "Port": 28080,
        "ListenerStatus": 0,
        "ListenerName": "http28080",
        "CreateTime": 1564640821
      }
    ],
    "RequestId": "4c43a7f7-3527-4e2a-9998-bbd363e4b095"
  }
}

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.

API 3.0 Explorer

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
FailedOperation	Operation failed
FailedOperation.NotSupportOldVersionProxy	Only connections of Version 2.0 are supported.
FailedOperation.NotSupportProxyGroup	This operation is not supported for connection groups.
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