产品概述
实例类型对比
产品功能
应用场景
产品规格上限说明
Domain name for API request: gaap.intl.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 Params. The value used for this API: DescribeHTTPSListeners. |
| 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 | 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 |
| Http3Supported | No | Integer | Specifies whether to enable HTTP3. Valid values:0: disable HTTP3;1: enable HTTP3.Note: If HTTP3 is enabled for a connection, the listener will use the port that is originally accessed to UDP, and a UDP listener with the same port cannot be created. After the connection is created, you cannot change your HTTP3 setting. |
| 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.
POST / HTTP/1.1
Host: gaap.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeHTTPSListeners
<Common request parameters>
{
"ProxyId": "link-n9ha8jzl",
"Limit": "20",
"Offset": "0"
}{
"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 | 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. |
文档反馈