1. 接口描述
接口请求域名： gaap.tencentcloudapi.com 。
该接口（CreateHTTPSListener）用于在通道实例下创建HTTPS协议类型的监听器。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateHTTPSListener。 |
| Version | 是 | String | 公共参数，本接口取值：2018-05-29。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| ListenerName | 是 | String | 监听器名称 示例值：listener-1 |
| Port | 是 | Integer | 监听器端口，基于同种传输层协议（TCP 或 UDP）的监听器，端口不可重复 示例值：443 |
| CertificateId | 是 | String | 服务器证书ID 示例值：N4Al2mhF |
| ForwardProtocol | 是 | String | 加速通道转发到源站的协议类型：HTTP | HTTPS 示例值：HTTP |
| ProxyId | 否 | String | 通道ID，与GroupId之间只能设置一个。表示创建通道的监听器。 示例值：link-cuxw2rm0 |
| AuthType | 否 | Integer | 认证类型，其中： 0，单向认证； 1，双向认证。 默认使用单向认证。 示例值：0 |
| ClientCertificateId | 否 | String | 客户端CA单证书ID，仅当双向认证时设置该参数或PolyClientCertificateIds参数 |
| PolyClientCertificateIds.N | 否 | Array of String | 新的客户端多CA证书ID，仅当双向认证时设置该参数或设置ClientCertificateId参数 示例值：[] |
| GroupId | 否 | String | 通道组ID，与ProxyId之间只能设置一个。表示创建通道组的监听器。 |
| Http3Supported | 否 | Integer | 支持Http3的开关，其中： 0，表示不需要支持Http3接入； 1，表示需要支持Http3接入。 注意：如果支持了Http3的功能，那么该监听器会占用对应的UDP接入端口，不可再创建相同端口的UDP监听器。 该功能的启停无法在监听器创建完毕后再修改。 示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ListenerId | String | 创建的监听器ID 示例值：listener-o0f3at99 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建HTTPS监听器
创建HTTPS监听器
输入示例
POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateHTTPSListener
<公共请求参数>
{
"ProxyId": "link-cuxw2rm0",
"ForwardProtocol": "HTTP",
"CertificateId": "N4Al2mhF",
"ListenerName": "listener-1",
"Port": "443"
}输出示例
{
"Response": {
"RequestId": "9aeda369-17c7-429f-be39-745c1e92fc71",
"ListenerId": "listener-o0f3at99"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.NotEnterpriseAuthorization | 非企业认证客户。 |
| AuthFailure.UnauthorizedOperation | 子账户未授权操作。 |
| FailedOperation | 操作失败。 |
| FailedOperation.GroupStatusNotInRuning | 通道组状态为非运行状态，无法操作。 |
| FailedOperation.InstanceStatusNotInRuning | 通道状态为非运行状态，无法操作。 |
| FailedOperation.LimitNumofListener | 监听器数量超过限制。 |
| FailedOperation.ListenerHasTask | 监听器正在操作中，请勿重复操作。 |
| FailedOperation.NonStandardProxy | 该通道为非标通道，限制所有写操作。 |
| FailedOperation.ProxyStatusNotInRuning | 通道处于非运行状态，不能添加监听器。 |
| FailedOperation.UserNotConfirmProtocol | 未开通协议。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.DuplicatedListenerPort | 监听器端口已存在。 |
| InvalidParameterValue.InvalidCertificateId | 证书不可用。 |
| InvalidParameterValue.InvalidListenerPort | 该监听器端口不可用。 |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable.AccountViolation | 账号下存在违规资源，详情请查看站内信或邮件。 |
| UnauthorizedOperation | 未授权操作。 |
| UnsupportedOperation | 操作不支持。 |
