全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 钉钉智能硬件
负载均衡

CreateLoadBalancerHTTPListener

更新时间:2017-08-24 15:34:01

描述

  • 创建HTTP Listener,为负载均衡实例创建基于HTTP协议的Listener,包含基于HTTP协议的策略及健康检查配置。
  • 新创建的Listener为stopped状态,需调用StartLoadBalancerListener,使之生效。Listener的状态转换图,参见负载均衡 Listener状态转换图

请求参数

名称 类型 是否必须 描述
Action String 操作接口名,系统规定参数。取值:CreateLoadBalancerHTTPListener
RegionId String 地域ID
LoadBalancerId String 负载均衡实例的唯一标识
ListenerPort Integer 负载均衡实例前端使用的端口。取值:1-65535
BackendServerPort Integer 负载均衡实例后端使用的端口。取值:1-65535
Bandwidth Integer 监听的带宽峰值。取值:-1 / 1-1000Mbps针对按固定带宽计费方式的公网类型实例,不同Listener上的Bandwidth分配的带宽峰值总和不能超出在创建负载均衡实例时设定的Bandwidth值,且不能将Listener上的Bandwidth设置为-1;针对按使用流量计费方式的公网类型实例,可以选择将Listener上的Bandwidth设置为-1,表示不限制带宽峰值
XForwardedFor String 是否开启通过X-Forwarded-For的方式获取来访者真实IP。

取值:on / off

默认值:on

注:考虑安全原因,本参数自2015年5月15日起会强制设置为on,考虑的接口兼容性,本接口入参还保留

XForwardedFor_SLBIP String 是否通过SLB-IP头字段获取来访者真实IP。

取值:on / off

默认值:off

XForwardedFor_SLBID String 是否通过SLB-ID头字段获取SLB实例ID。

取值:on / off

默认值:off

XForwardedFor_proto String 是否通过X-Forwarded-Proto头字段获取SLB的监听协议。

取值:on / off

默认值:off

Scheduler String 调度算法。

取值:wrr / wlc

默认值:wrr

StickySession String 是否开启会话保持。

取值:on / off

StickySessionType String 视情况而定 cookie的处理方式。

该参数在StickySession为on时为必选;当StickySession为off时,此参数设置将被忽略。

取值:insert / server设置为insert表示由负载均衡插入,设置为server表示负载均衡从后端服务器学习

CookieTimeout Integer 视情况而定 cookie超时时间。该参数在StickySession为on且StickySessionType为insert时为必选,其余情况下该参数会被忽略。取值: 1-86400(单位为秒)
Cookie String 视情况而定 服务器上配置的cookie。仅在StickySession为on且StickySessionType为server时为必选;其余情况下该参数会被忽略。取值:遵守RFC 2965且长度为1-200的字符串。只能包含 ASCII 英文字母数字字符,不能包含逗号、分号或空格,也不能以 $ 字符开头
HealthCheck String 是否开启健康检查。取值:on / off
HealthCheckDomain String 用于健康检查的域名。取值:$_ip / 用户自定义字符串/空自定义字符串规则:长度限制为1-80,只能使用字母、数字、‘-’、‘.’这些字符。用户设置此参数为’$_ip’或空时,负载均衡会使用各后端服务器的私网IP当做健康检查使用的Domain
HealthCheckURI String 视情况而定 用于健康检查的URI。当HealthCheck为on时,此参数为必选;当HealthCheck为off时,此参数设置将被忽略。取值:长度限制为1-80,必须以’/’开头。只能使用字母、数字、‘-’、‘/’、‘.’、‘%’、‘?’、‘#’、‘&’这些字符
HealthCheckConnectPort Integer 视情况而定 进行健康检查时使用的端口。当HealthCheck为on时,此参数为必选;当HealthCheck为off时,此参数设置将被忽略。取值:1-65535,或者’-520’ 。用户设置此参数为’-520’时,表示使用后端服务端口(BackendServerPort)
HealthyThreshold Integer 视情况而定 判定健康检查结果为fail的阈值。即,健康检查连续失败多少次后,将后端服务器的健康检查状态由success改为fail。当HealthCheck为on时,此参数为必选;当HealthCheck为off时,此参数设置将被忽略。取值:1-10
UnhealthyThreshold Integer 视情况而定 判定健康检查结果为fail的阈值。即,健康检查连续失败多少次后,将后端服务器的健康检查状态由success改为fail。当HealthCheck为on时,此参数为必选;当HealthCheck为off时,此参数设置将被忽略。取值:1-10
HealthCheckTimeout Integer 视情况而定 每次健康检查响应的最大超时时间。当HealthCheck为on时,此参数为必选;当HealthCheck为off时,此参数设置将被忽略。取值:1-50(单位为秒)注意:如果HealthCHeckTimeout < HealthCheckInterval,则HCTimeout无效,超时时间为HealthCheckInterval
HealthCheckInterval Integer 视情况而定 进行健康检查的时间间隔。当HealthCheck为on时,此参数为必选;当HealthCheck为off时,此参数设置将被忽略。取值:1-5(单位为秒)
HealthCheckHttpCode String 视情况而定 健康检查正常的http状态码,多个http状态码间用”,”分割。当HealthCheck为on时,此参数为可选;当HealthCheck为off时,此参数设置将被忽略。取值:http_2xx / http_3xx / http_4xx / http_5xx默认值:http_2xx
VServerGroupId String 虚拟服务器组ID
Gzip String 是否开启Gzip压缩,开启将对特定文件类型进行压缩;关闭则不会对任何文件类型进行压缩取值:on / off默认值:on

返回参数

全是公共返回参数,详见<公共返回参数>

示例

请求示例

  1. https://slb.aliyuncs.com/
  2. &Action=CreateLoadBalancerHTTPListener
  3. &LoadBalancerId=139a00604ad-cn-east-hangzhou-01
  4. &ListenerPort=80
  5. &BackendServerPort=80
  6. &Bandwidth=-1
  7. &HealthCheck=on
  8. &HealthCheckDomain=$_ip
  9. &HealthCheckURI=/test/index.html
  10. &HealthCheckConnectPort=8080
  11. &HealthyThreshold=4
  12. &UnhealthyThreshold=4
  13. &HealthCheckTimeout=3
  14. &HealthCheckInterval=5
  15. &VServerGroupId=rsp-cige6j5e7p
  16. &<公共请求参数>

返回示例

  • XML格式
    1. <?xml version="1.0" encoding="UTF-8"?>
    2. <CreateLoadBalancerHTTPListenerResponse>
    3. <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
    4. </CreateLoadBalancerHTTPListenerResponse>
  • JSON格式
    1. {"RequestId":" CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
    2. }
本文导读目录