创建应用型四层负载均衡监听器

最近更新时间:2018-06-01 14:56:42

接口描述

CreateForwardLBFourthLayerListeners 接口提供了创建负载均衡四层监听器功能。负载均衡四层监听器提供了转发用户请求的具体规则,包括端口、协议、会话保持、健康检查等参数。

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

请求参数

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

参数名称 必选 类型 描述
loadBalancerId String 负载均衡实例 ID,可通过 DescribeLoadBalancers 接口查询。
listeners.n.loadBalancerPort Int 负载均衡监听器的监听接口,可选值:1~65535。listeners 为数组,可以创建多个监听器,n 为下标。
listeners.n.protocol Int 负载均衡实例监听器协议类型 2:TCP,3:UDP。
listeners.n.listenerName String 负载均衡监听器的监听名称。
listeners.n.sessionExpire Int 负载均衡监听器的会话保持时间,单位:秒。可选值:30~3600,默认 0,表示不开启。
listeners.n.healthSwitch Int 负载均衡实例监听器是否开启健康检查:1(开启)、0(关闭)。默认值 1,表示打开。
listeners.n.timeOut Int 负载均衡监听器健康检查的响应超时时间,可选值:2~60,默认值:2,单位:秒。响应超时时间要小于检查间隔时间。
listeners.n.intervalTime Int 负载均衡监听器检查间隔时间,默认值:5,可选值:5~300,单位:秒。
listeners.n.healthNum Int 负载均衡监听器健康阈值,默认值:3,表示当连续探测三次健康则表示该转发正常,可选值:2~10,单位:次。
listeners.n.unhealthNum Int 负载均衡监听器不健康阈值,默认值:3,表示当连续探测三次不健康则表示该转发异常,可选值:2~10,单位:次。
listeners.n.scheduler String 负载均衡监听器转发的方式。可选值:wrr、least_conn
分别表示按权重轮询、最小连接数, 默认为 wrr。

返回参数

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

示例

请求

https://lb.api.qcloud.com/v2/index.php?Action=CreateForwardLBFourthLayerListeners
&<公共请求参数>
&loadBalancerId=lb-abcdefgh
&listeners.0.loadBalancerPort=80
&listeners.0.protocol=2
&listeners.0.listenerName=2

返回

{
  "code" : 0,
  "message" : "",
  "codeDesc": "Success",
  "requestId" : 123,
  "listenerIds": [
        "lbl-3jt7mido"
      ]
}