DescribeHTTPSListeners
Last updated: 2020-01-16 11:08:52
Contents：
1. API Description
Domain name for API request: gaap.tencentcloudapi.com.
This API (DescribeHTTPSListeners) is used to query HTTPS listener information.
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: DescribeHTTPSListeners |
| 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 | Filter condition. 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. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Quantity of listeners |
| ListenerSet | Array of HTTPSListener | HTTPS 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 HTTPS Listener Information
Query the HTTPS listener information.
Input Example
https://gaap.tencentcloudapi.com/?Action=DescribeHTTPSListeners
&ProxyId=link-n9ha8jzl
&Offset=0
&Limit=20
&<Common request parameters>Output Example
{
"Response": {
"TotalCount": 11,
"ListenerSet": [
{
"ForwardProtocol": "HTTPS",
"ClientCertificateId": null,
"CertificateId": "Sv8lFuYh",
"Protocol": "HTTPS",
"CertificateAlias": "lagameft01_test",
"AuthType": 0,
"ListenerId": "listener-eqq49dct",
"ListenerStatus": 0,
"ListenerName": "httpstohttps443",
"ClientCertificateAlias": null,
"CreateTime": 1563340571,
"Port": 443
},
{
"ForwardProtocol": "HTTPS",
"ClientCertificateId": "",
"CertificateId": "cert-r79xf99t",
"Protocol": "HTTPS",
"CertificateAlias": "borisuser001",
"AuthType": 0,
"ListenerId": "listener-85646933",
"ListenerStatus": 0,
"ListenerName": "testcert001",
"ClientCertificateAlias": null,
"CreateTime": 1564201158,
"Port": 1443
}
],
"RequestId": "db5cebe8-b79a-401c-8704-388776fae938"
}
}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 |
| 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 |
