当前位置:主页 > 查看内容

负载均衡 修改负载均衡监听器属性 - API 文档

发布时间:2021-09-23 00:00| 位朋友查看

简介:1. 接口描述 接口请求域名: clb.tencentcloudapi.com 。 ModifyListener接口用来修改负载均衡监听器的属性,包括监听器名称、健康检查参数、证书信息、转发策略等。本接口不支持传统型负载均衡。本接口为异步接口,本接口返回成功后需以返回的RequestID为入……

1. 接口描述

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

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

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:clb.ap-shanghai-fsi.tencentcloudapi.com。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyListener。
Version String 公共参数,本接口取值:2018-03-17。
Region String 公共参数,详见产品支持的 地域列表。
LoadBalancerId String 负载均衡实例ID。
ListenerId String 负载均衡监听器ID。
ListenerName String 新的监听器名称。
SessionExpireTime Integer 会话保持时间,单位:秒。可选值:30~3600,默认 0,表示不开启。此参数仅适用于TCP/UDP监听器。
HealthCheck HealthCheck 健康检查相关参数,此参数仅适用于TCP/UDP/TCP_SSL监听器。
Certificate CertificateInput 证书相关信息,此参数仅适用于HTTPS/TCP_SSL监听器。
Scheduler String 监听器转发的方式。可选值:WRR、LEAST_CONN
分别表示按权重轮询、最小连接数, 默认为 WRR。
SniSwitch Integer 是否开启SNI特性,此参数仅适用于HTTPS监听器。注意:未开启SNI的监听器可以开启SNI;已开启SNI的监听器不能关闭SNI。
KeepaliveEnable Integer 是否开启长连接,此参数仅适用于HTTP/HTTPS监听器。

3. 输出参数

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

4. 示例

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

输入示例

https://clb.tencentcloudapi.com/?Action=ModifyListener
&LoadBalancerId=lb-cuxw2rm0
&ListenerId=lbl-d1ubsydq
&ListenerName=newlis
&SessionExpireTime=120
&Scheduler=LEAST_CONN
&HealthCheck.HealthSwitch=1
&HealthCheck.TimeOut=35
&HealthCheck.IntervalTime=60
&HealthCheck.HealthNum=5
&HealthCheck.UnHealthNum=5
&<公共请求参数>

输出示例

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

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

输入示例

https://clb.tencentcloudapi.com/?Action=ModifyListener
&LoadBalancerId=lb-cuxw2rm0
&ListenerId=lbl-4fbxq45k
&Certificate.SSLMode=UNIDIRECTIONAL
&Certificate.CertId=Nb1DY3hQ
&<公共请求参数>

输出示例

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

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
  • Tencent Cloud SDK 3.0 for Java
  • Tencent Cloud SDK 3.0 for PHP
  • Tencent Cloud SDK 3.0 for Go
  • Tencent Cloud SDK 3.0 for NodeJS
  • Tencent Cloud SDK 3.0 for .NET
  • Tencent Cloud SDK 3.0 for C++
  • Tencent Cloud SDK 3.0 for Ruby

命令行工具

  • Tencent Cloud CLI 3.0

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.FormatError 参数格式错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.Length 参数长度错误。
MissingParameter 缺少参数错误。
UnauthorizedOperation 未授权操作。

本站部分内容转载于网络,版权归原作者所有,转载之目的在于传播更多优秀技术内容,如有侵权请联系QQ/微信:153890879删除,谢谢!
上一篇:克隆垂直伸缩任务 - 弹性伸缩 下一篇:没有了

推荐图文

  • 周排行
  • 月排行
  • 总排行

随机推荐