修改负载均衡监听器属性
最近更新时间: 2024-06-18 14:31:28
1. 接口描述
接口请求域名： clb.api3.fincloud.tencent.cn。
ModifyListener接口用来修改负载均衡监听器的属性，包括监听器名称、健康检查参数、证书信息、转发策略等。本接口不支持传统型负载均衡。 本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
默认接口请求频率限制：20次/秒。
接口更新时间：2019-10-22 12:17:13。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：ModifyListener |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-03-17 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| LoadBalancerId | 是 | 否 | String | 负载均衡实例 ID |
| ListenerId | 是 | 否 | String | 负载均衡监听器 ID |
| ListenerName | 否 | 否 | String | 新的监听器名称 |
| SessionExpireTime | 否 | 否 | Int64 | 会话保持时间，单位：秒。可选值：30~3600，默认 0，表示不开启。此参数仅适用于TCP/UDP监听器。 |
| HealthCheck | 否 | 否 | HealthCheck | 健康检查相关参数，此参数仅适用于TCP/UDP/TCP_SSL监听器 |
| Certificate | 否 | 否 | CertificateInput | 证书相关信息，此参数仅适用于HTTPS/TCP_SSL监听器 |
| Scheduler | 否 | 否 | String | 监听器转发的方式。可选值：WRR、LEAST_CONN<br>分别表示按权重轮询、最小连接数， 默认为 WRR。 |
| SniSwitch | 否 | 否 | Int64 | 是否开启SNI特性，此参数仅适用于HTTPS监听器。注意：未开启SNI的监听器可以开启SNI；已开启SNI的监听器不能关闭SNI |
| TargetType | 否 | 否 | String | 此参数对外不可见。 后端目标类型，NODE表示绑定普通节点，TARGETGROUP表示绑定目标组 |
| DefaultSerSwitch | 否 | 否 | Bool | 监听器是否支持设置默认域名，默认为支持 |
| NewDefaultServerDomain | 否 | 否 | String | 开启监听器默认域名开关时，指定该监听器下任意域名为默认域名，当DefaultSerSwitch传值为ture时，且该监听器有存量域名时，该参数为必填，并同时生效。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | |
| InvalidParameterValue | |
| InternalError | |
| UnauthorizedOperation | |
| FailedOperation | |
| InvalidParameter.FormatError | |
| InvalidParameterValue.Length | |
| MissingParameter |