修改负载均衡监听器属性

最近更新时间:2018-06-01 16:45:25

接口描述

ModifyLoadBalancerListener 接口用来修改负载均衡监听器的属性。

接口访问域名:lb.api.qcloud.com

请求参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见 公共请求参数 页面。其中,此接口的 Action 字段为 ModifyLoadBalancerListener。

参数名称 必选 类型 描述
loadBalancerId String 负载均衡实例 ID,可通过 DescribeLoadBalancers 接口查询。
listenerId String 负载均衡监听器 ID,可通过 DescribeLoadBalancerListeners 接口查询。
listenerName String 监听器名称。
sessionExpire Int 会话保持时间,0 表示关闭,可选值:30-3600。
healthSwitch Int 是否开启健康检查:1(开启)、0(关闭)。
timeOut Int 响应超时时间,可传值为 2-60 秒;
公网属性负载均衡 HTTP、HTTPS 协议的监听器响应超时时间暂不能设置。
intervalTime Int 检查间隔,可选值:5-300。默认值 5。
healthNum Int 健康阈值,可选值:2-10。
unhealthNum Int 不健康阈值,可选值:2-10。
scheduler String 负载均衡监听器转发的方式,该值不可以与 httpHash 同时传入。公网属性负载均衡(监听器为TCP、UDP)才支持此字段,可传值:wrr、least_conn。分别表示按权重轮询、最小连接数。
httpHash String 负载均衡监听器转发的方式。公网属性负载均衡(监听器为 HTTP、HTTPS)才支持此字段,可传值:wrr、ip_hash,least_conn
分别表示按权重轮询、根据源 IP 进行哈希出一个值转发到后端机器、最小连接数, 默认为 wrr。
httpCode Int 对于 HTTP、HTTPS 协议的监听器,以该返回码来判断健康与否。可选值:1~31,默认 31。
1 表示返回值 1xx 表示健康,2 表示返回 2xx 表示健康,4 表示返回 3xx 表示健康,8 表示返回 4xx 表示健康,16 表示返回 5xx 表示健康。若返回多种表示健康,则将相应的值累加。
httpCheckPath String 公网属性负载均衡 HTTP、HTTPS 协议的监听器,健康检查的路径,默认/,必须以/开头。
SSLMode String 公网属性负载均衡 HTTPS 协议监听器的认证类型,unidirectional:单向认证,mutual:双向认证。
certId String 公网属性负载均衡 HTTPS 协议监听器新的服务端证书 ID。
certCaId String 公网属性负载均衡 HTTPS 协议监听器新的客户端证书 ID。
certCaContent String 公网属性负载均衡 HTTPS 协议监听器新的客户端证书内容。
certCaName String 公网属性负载均衡 HTTPS 协议监听器新的客户端证书名称。
certContent String 公网属性负载均衡 HTTPS 协议监听器新的服务端证书内容。
certKey String 公网属性负载均衡 HTTPS 协议监听器新的服务端证书的密钥。
certName String 公网属性负载均衡 HTTPS 协议监听器新的服务端证书的名称。

返回参数

参数名称 类型 描述
code Int 公共错误码,0 表示成功,其他值表示失败。详见错误码页面的 公共错误码
message String 模块错误信息描述,与接口相关。
codeDesc String 英文错误码,成功返回 Success,失败有相应的英文说明。
requestId Int 请求任务 ID,可根据 DescribeLoadBalancersTaskResult 接口查询操作状态。

示例

请求


https://lb.api.qcloud.com/v2/index.php?Action=ModifyLoadBalancerListener
&<公共请求参数>
loadBalancerId=lb-ltkip4do
&listenerId=lbl-6hkiqc6c
&SSLMode=unidirectional

返回

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "requestId": 18642
}