有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: gaap.tencentcloudapi.com 。

本接口(DescribeHTTPSListeners)用来查询HTTPS监听器信息。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeHTTPSListeners。
Version String 公共参数,本接口取值:2018-05-29。
Region String 公共参数,此参数为可选参数。
ProxyId String 过滤条件,通道ID
示例值:link-n9ha8jzl
ListenerId String 过滤条件,根据监听器ID进行精确查询。
ListenerName String 过滤条件,根据监听器名称进行精确查询。
Port Integer 过滤条件,根据监听器端口进行精确查询。
示例值:80
Offset Integer 偏移量, 默认为0
示例值:0
Limit Integer 限制数量,默认为20
示例值:20
SearchValue String 过滤条件,支持按照端口或监听器名称进行模糊查询
GroupId String 过滤条件,通道组ID
Http3Supported Integer 支持Http3的开关,其中:
0,表示不需要支持Http3接入;
1,表示需要支持Http3接入。
注意:如果支持了Http3的功能,那么该监听器会占用对应的UDP接入端口,不可再创建相同端口的UDP监听器。
该功能的启停无法在监听器创建完毕后再修改。
示例值:0

3. 输出参数

参数名称 类型 描述
TotalCount Integer 监听器数量
示例值:11
ListenerSet Array of HTTPSListener HTTPS监听器列表
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询HTTPS监听器信息

查询HTTPS监听器信息

输入示例

POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeHTTPSListeners
<公共请求参数>

{
    "ProxyId": "link-n9ha8jzl",
    "Limit": "20",
    "Offset": "0"
}

输出示例

{
    "Response": {
        "TotalCount": 11,
        "ListenerSet": [
            {
                "ForwardProtocol": "HTTPS",
                "ClientCertificateId": "123",
                "CertificateId": "Sv8lFuYh",
                "Protocol": "HTTPS",
                "CertificateAlias": "lagameft01_test勿删除",
                "AuthType": 0,
                "ListenerId": "listener-eqq49dct",
                "ListenerStatus": 0,
                "ListenerName": "连通性测试httpstohttps443",
                "ClientCertificateAlias": "sdvadf",
                "CreateTime": 1563340571,
                "Port": 443,
                "PolyClientCertificateAliasInfo": [
                    {
                        "CertificateId": "123",
                        "CertificateAlias": "alis"
                    }
                ]
            },
            {
                "ForwardProtocol": "HTTPS",
                "ClientCertificateId": "",
                "CertificateId": "cert-r79xf99t",
                "Protocol": "HTTPS",
                "CertificateAlias": "boris服务器证书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"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.NotEnterpriseAuthorization 非企业认证客户。
AuthFailure.UnauthorizedOperation 子账户未授权操作。
FailedOperation 操作失败。
FailedOperation.NotSupportOldVersionProxy 仅支持Version2.0的通道。
FailedOperation.NotSupportProxyGroup 该操作不支持通道组。
FailedOperation.UserNotConfirmProtocol 未开通协议。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
ResourceNotFound 资源不存在。
ResourceUnavailable.AccountViolation 账号下存在违规资源,详情请查看站内信或邮件。
UnauthorizedOperation 未授权操作。