产品概述
实例类型对比
产品功能
应用场景
产品规格上限说明
Domain name for API request: gaap.intl.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.
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: DescribeHTTPListeners. |
| Version | Yes | String | Common Params. The value used for this API: 2018-05-29. |
| Region | No | String | Common Params. This parameter is not required. |
| 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 |
| 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. |
This example shows you how to query the HTTP listener information.
POST / HTTP/1.1
Host: gaap.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeHTTPListeners
<Common request parameters>
{
"ProxyId": "link-n9ha8jzl",
"Limit": "20",
"Offset": "0"
}{
"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"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | CAM signature/authentication error. |
| AuthFailure.NotEnterpriseAuthorization | Not an organizational customer. |
| AuthFailure.UnauthorizedOperation | The sub-account is not authorized for this operation. |
| FailedOperation | Operation failed. |
| FailedOperation.NotSupportOldVersionProxy | Only connections of Version 2.0 are supported. |
| FailedOperation.NotSupportProxyGroup | This operation is not supported for connection groups. |
| FailedOperation.UserNotConfirmProtocol | Protocol not activated. |
| 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. |
文档反馈