API 文档

创建HTTPS监听器

最近更新时间:2020-10-13 08:04:06

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 监听器名称
Port Integer 监听器端口,基于同种传输层协议(TCP 或 UDP)的监听器,端口不可重复
CertificateId String 服务器证书ID
ForwardProtocol String 加速通道转发到源站的协议类型:HTTP | HTTPS
ProxyId String 通道ID,与GroupId之间只能设置一个。表示创建通道的监听器。
AuthType Integer 认证类型,其中:
0,单向认证;
1,双向认证。
默认使用单向认证。
ClientCertificateId String 客户端CA单证书ID,仅当双向认证时设置该参数或PolyClientCertificateIds参数
PolyClientCertificateIds.N Array of String 新的客户端多CA证书ID,仅当双向认证时设置该参数或设置ClientCertificateId参数
GroupId String 通道组ID,与ProxyId之间只能设置一个。表示创建通道组的监听器。

3. 输出参数

参数名称 类型 描述
ListenerId String 创建的监听器ID
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建HTTPS监听器

创建HTTPS监听器

输入示例

https://gaap.tencentcloudapi.com/?Action=CreateHTTPSListener
&InstanceId=link-cuxw2rm0
&ListenerName=listener-1
&Port=443
&CertificateId=N4Al2mhF
&ForwardProtocol=HTTP
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "9aeda369-17c7-429f-be39-745c1e92fc71",
    "ListenerId": "listener-o0f3at99"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.GroupStatusNotInRuning 通道组状态为非运行状态,无法操作。
FailedOperation.InstanceStatusNotInRuning 通道状态为非运行状态,无法操作。
FailedOperation.LimitNumofListener 监听器数量超过限制。
FailedOperation.ListenerHasTask 监听器正在操作中,请勿重复操作。
FailedOperation.ProxyStatusNotInRuning 通道处于非运行状态,不能添加监听器。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.DuplicatedListenerPort 监听器端口已存在。
InvalidParameterValue.InvalidCertificateId 证书不可用。
InvalidParameterValue.InvalidListenerPort 该监听器端口不可用。
MissingParameter 缺少参数错误。
ResourceNotFound 资源不存在。
UnauthorizedOperation 未授权操作。
目录