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.
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. |
| GroupId | No | String | Connection group ID as a filter |
| 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. |
This example shows you how to query the HTTPS listener information.
https://gaap.tencentcloudapi.com/?Action=DescribeHTTPSListeners
&ProxyId=link-n9ha8jzl
&Offset=0
&Limit=20
&<Common request parameters>{
"Response": {
"TotalCount": 11,
"ListenerSet": [
{
"ForwardProtocol": "HTTPS",
"ClientCertificateId": "123",
"CertificateId": "Sv8lFuYh",
"Protocol": "HTTPS",
"CertificateAlias": "lagameft01_test Do not delete",
"AuthType": 0,
"ListenerId": "listener-eqq49dct",
"ListenerStatus": 0,
"ListenerName": "Connectivity test httpstohttps443",
"ClientCertificateAlias": "sdvadf",
"CreateTime": 1563340571,
"Port": 443,
"PolyClientCertificateAliasInfo": [
{
"CertificateId": "123",
"CertificateAlias": "alis"
}
]
},
{
"ForwardProtocol": "HTTPS",
"ClientCertificateId": "",
"CertificateId": "cert-r79xf99t",
"Protocol": "HTTPS",
"CertificateAlias": "Boris server certificate user001",
"AuthType": 0,
"ListenerId": "listener-85646933",
"ListenerStatus": 0,
"ListenerName": "testcert001",
"ClientCertificateAlias": null,
"CreateTime": 1564201158,
"Port": 1443,
"PolyClientCertificateAliasInfo": [
{
"CertificateId": "123",
"CertificateAlias": "alis"
}
]
}
],
"RequestId": "db5cebe8-b79a-401c-8704-388776fae938"
}
}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.NotEnterpriseAuthorization | Not an organizational customer. |
| 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 | Incorrect parameter. |
| InvalidParameterValue | Incorrect parameter value. |
| MissingParameter | Missing parameter. |
| ResourceNotFound | The resource does not exist. |
| UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?