CreateListener
最近更新时间: 2025-10-20 17:05:53
1. 接口描述
接口请求域名： clb.api3.fincloud.tencent.cn。
在一个负载均衡实例下创建监听器。 本接口为异步接口，接口返回成功后，需以返回的 RequestId 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。
默认接口请求频率限制：20次/秒。
接口更新时间：2021-08-22 15:35:31。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateListener |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-03-17 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| LoadBalancerId | 是 | 否 | String | 负载均衡实例 ID |
| Ports | 是 | 否 | Array of Int64 | 要将监听器创建到哪些端口，每个端口对应一个新的监听器 |
| Protocol | 是 | 否 | String | 监听器协议： TCP | UDP | HTTP | HTTPS | TCP_SSL（TCP_SSL 正在内测中，如需使用请通过工单申请） |
| ListenerNames | 否 | 否 | Array of String | 要创建的监听器名称列表，名称与Ports数组按序一一对应，如不需立即命名，则无需提供此参数 |
| HealthCheck | 否 | 否 | HealthCheck | 健康检查相关参数，此参数仅适用于TCP/UDP/TCP_SSL监听器 |
| Certificate | 否 | 否 | CertificateInput | 证书相关信息，此参数仅适用于TCP_SSL监听器和未开启SNI特性的HTTPS监听器。 |
| SessionExpireTime | 否 | 否 | Int64 | 会话保持时间，单位：秒。可选值：30~3600，默认 0，表示不开启。此参数仅适用于TCP/UDP监听器。 |
| Scheduler | 否 | 否 | String | 监听器转发的方式。可选值：WRR、LEAST_CONN<br>分别表示按权重轮询、最小连接数， 默认为 WRR。此参数仅适用于TCP/UDP/TCP_SSL监听器。 |
| SniSwitch | 否 | 否 | Int64 | 是否开启SNI特性，此参数仅适用于HTTPS监听器。 |
| TargetType | 否 | 否 | String | 此参数对外不可见。 后端目标类型，NODE表示绑定普通节点，TARGETGROUP表示绑定目标组。 |
| DefaultSerSwitch | 否 | 否 | Bool | 监听器是否支持设置默认域名，默认为支持 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ListenerIds | String | 此参数对外不可见。 创建的监听器的唯一标识数组 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误 |
| InternalError | 内部错误 |
| UnauthorizedOperation | 未授权操作 |
| ResourceInsufficient | 资源不足 |
| LimitExceeded | 超过配额限制 |
| FailedOperation | 操作失败 |
| InvalidParameter.FormatError | 参数格式错误。 |
| InvalidParameterValue.Length | 参数长度错误。 |
| MissingParameter | 缺少参数错误。 |
| InvalidParameter.PortCheckFailed | 监听器端口检查失败，比如端口冲突。 |