API 中心
视频服务与安全产品捉虫活动邀您参加！> HOT
文档中心>API 中心>负载均衡>监听器相关接口>修改负载均衡监听器属性

修改负载均衡监听器属性

最近更新时间：2024-05-07 01:12:06

我的收藏

本页目录：

1. 接口描述

接口请求域名： clb.tencentcloudapi.com 。

ModifyListener接口用来修改负载均衡监听器的属性，包括监听器名称、健康检查参数、证书信息、转发策略等。本接口不支持传统型负载均衡。
本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：ModifyListener。
Version 是 String 公共参数，本接口取值：2018-03-17。
Region 是 String 公共参数，详见产品支持的 地域列表。
LoadBalancerId 是 String 负载均衡实例ID。
示例值：lb-cuxw****
ListenerId 是 String 负载均衡监听器ID。
示例值：lbl-d1ub****
ListenerName 否 String 新的监听器名称。
示例值：newlis
SessionExpireTime 否 Integer 会话保持时间，单位：秒。可选值：30~3600，默认 0，表示不开启。此参数仅适用于TCP/UDP监听器。
示例值：120
HealthCheck 否 HealthCheck 健康检查相关参数，此参数仅适用于TCP/UDP/TCP_SSL/QUIC监听器。
Certificate 否 CertificateInput 证书相关信息，此参数仅适用于HTTPS/TCP_SSL/QUIC监听器；此参数和MultiCertInfo不能同时传入。
Scheduler 否 String 监听器转发的方式。可选值：WRR、LEAST_CONN
分别表示按权重轮询、最小连接数， 默认为 WRR。
使用场景：适用于TCP/UDP/TCP_SSL/QUIC监听器。七层监听器的均衡方式应在转发规则中修改。
示例值：LEAST_CONN
SniSwitch 否 Integer 是否开启SNI特性，此参数仅适用于HTTPS监听器。默认0，表示不开启，1表示开启。注意：未开启SNI的监听器可以开启SNI；已开启SNI的监听器不能关闭SNI。
示例值：0
TargetType 否 String 后端目标类型，NODE表示绑定普通节点，TARGETGROUP表示绑定目标组。
示例值：NODE
KeepaliveEnable 否 Integer 是否开启长连接，此参数仅适用于HTTP/HTTPS监听器。
默认值0表示不开启，1表示开启。
示例值：0
DeregisterTargetRst 否 Boolean 解绑后端目标时，是否发RST给客户端，此参数仅适用于TCP监听器。
示例值：False
SessionType 否 String 会话保持类型。NORMAL表示默认会话保持类型。QUIC_CID表示根据Quic Connection ID做会话保持。QUIC_CID只支持UDP协议。
使用场景：适用于TCP/UDP/TCP_SSL/QUIC监听器。
示例值：NORMAL
MultiCertInfo 否 MultiCertInfo 证书信息，支持同时传入不同算法类型的多本服务端证书；此参数仅适用于未开启SNI特性的HTTPS监听器。此参数和Certificate不能同时传入。
MaxConn 否 Integer 监听器粒度并发连接数上限，当前仅性能容量型实例且仅TCP/UDP/TCP_SSL/QUIC监听器支持。取值范围：1-实例规格并发连接上限，其中-1表示关闭监听器粒度并发连接数限速。基础网络实例不支持该参数。
示例值：-1
MaxCps 否 Integer 监听器粒度新建连接数上限，当前仅性能容量型实例且仅TCP/UDP/TCP_SSL/QUIC监听器支持。取值范围：1-实例规格新建连接上限，其中-1表示关闭监听器粒度新建连接数限速。基础网络实例不支持该参数。
示例值：-1
IdleConnectTimeout 否 Integer 空闲连接超时时间，此参数仅适用于TCP监听器，单位：秒。默认值：900，取值范围：共享型实例和独占型实例支持：300～900，性能容量型实例支持：300~2000。如需设置超过2000s，请通过 工单申请,最大可设置到3600s。
示例值：900
SnatEnable 否 Boolean 是否开启SNAT。
示例值：False

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改HTTPS监听器绑定的证书

修改HTTPS监听器绑定的证书

输入示例

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

{
    "ListenerId": "lbl-4fbxq45k",
    "Certificate": {
        "SSLMode": "UNIDIRECTIONAL",
        "CertId": "Nb1DY3hQ"
    },
    "LoadBalancerId": "lb-cuxw2rm0"
}

输出示例

{
    "Response": {
        "RequestId": "b64574f9-5bc7-4a63-a9d7-3671b6a6d62b"
    }
}

示例2 修改TCP监听器的名称、健康检查参数及转发策略

修改TCP监听器的名称、健康检查参数及转发策略

输入示例

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

{
    "HealthCheck": {
        "UnHealthNum": "5",
        "HealthNum": "5",
        "IntervalTime": "60",
        "TimeOut": "35",
        "HealthSwitch": "1"
    },
    "LoadBalancerId": "lb-cuxw2rm0",
    "ListenerId": "lbl-d1ubsydq",
    "ListenerName": "newlis",
    "Scheduler": "LEAST_CONN",
    "SessionExpireTime": "120"
}

输出示例

{
    "Response": {
        "RequestId": "8cd88c83-fd30-47c0-8e7a-89bf13a7a83c"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.ResourceInOperating 正在操作指定的资源，请稍后重试。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.FormatError 参数格式错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.Length 参数长度错误。
MissingParameter 缺少参数错误。
UnauthorizedOperation 未授权操作。
中国站
文档反馈
文档活动
message-icon联系我们
目录