监听相关API：CreateLoadBalancerTCPListener

描述

• 创建TCP Listener，为负载均衡实例创建基于TCP协议的Listener，包含基于TCP协议的策略及健康检查配置。
• 新创建的Listener为Stoped状态，需调用StartLoadBalancerListener，使之生效。Listener的状态转换图，参见负载均衡 Listener状态转换图。
• TCP Listener的健康检查永远为开启状态，用户可设置健康检查时的各项参数配置，但是不能将健康检查关闭。TCP Listener的健康检查默认为使用TCP方式进行健康检查，如需要使用HTTP方式进行健康检查，需要设置特定的参数。

请求参数


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

名称	类型	是否必须	描述
Action	String	是	操作接口名，系统规定参数。取值：CreateLoadBalancerTCPListener。
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，表示不限制带宽峰值。
Scheduler	String	否	调度算法。 取值：wrr/wlc。 默认值：wrr。
PersistenceTimeout	Integer	否	连接持久化的超时时间。取值： 0-3600（单位为秒）。默认值：0 其中，0表示关闭。
HealthCheckType	String	否	健康检查类型。 取值：tcp/http 默认值：tcp TCP协议支持使用TCP和HTTP两种健康检查方式，可根据应用情况选择需要的健康检查方式。
HealthCheckDomain	String	否	用于健康检查的域名。当TCP监听需要使用HTTP健康检查时可配置此参数，如不配置则按TCP健康检查。 取值： $_ip/用户自定义字符串/空 自定义字符串规则：长度限制为1-80，只能使用字母、数字、‘-’、‘.’这些字符。 用户设置此参数为’$_ip’或空时，负载均衡会使用各后端服务器的私网IP当做健康检查使用的Domain。 注：由于有的Region还存在BUG，暂时无法支持健康检查域名设置，我们正在加紧修复该问题。当前请使用TCP健康检查或者不设置HTTP健康检查域名，系统会统一使用各后端服务器的内网IP作为域名。
HealthCheckURI	String	视情况而定	用于健康检查的URI。当TCP监听需要使用HTTP健康检查时可配置此参数，如不配置则按TCP健康检查。 取值：长度限制为1-80，必须以’/’开头。只能使用字母、数字、‘-’、‘/’、‘.’、‘%’、‘?’、‘#’、‘&’这些字符。
HealthCheckConnectPort	Integer	否	进行健康检查使用的端口。 取值： 1-65535 默认值：无 不设置此参数时，表示使用后端服务端口（BackendServerPort）。
HealthyThreshold	Integer	否	判定健康检查结果为success的阈值。即，健康检查连续成功多少次后，将后端服务器的健康检查结果由fail改为success。 取值：1-10 默认值：3。
UnhealthyThreshold	Integer	视情况而定	判定健康检查结果为fail的阈值。即，健康检查连续失败多少次后，将后端服务器的健康检查状态由success改为fail。 取值：1-10 默认值：3。
HealthCheckTimeout	Integer	否	健康检查的连接超时时间。 取值：1-50（单位为秒） 默认值：5。
HealthCheckInterval	Integer	否	进行健康检查的时间间隔。 取值：1-5（单位为秒） 默认值：2。
HealthCheckHttpCode	String	否	健康检查正常的http状态码，多个http状态码间用”,”分割。当TCP监听需要使用HTTP健康检查时可配置此参数。如不配置则按TCP健康检查。 取值：http_2xx | http_3xx/http_4xx/http_5xx。 默认值：http_2xx。
VServerGroupId	String	否	虚拟服务器组ID，虚拟服务器组ID和主备服务器组ID只能传其中一个，不允许二者都传。
MasterSlaveServerGroupId	String	否	主备服务器组ID，虚拟服务器组ID和主备服务器组ID只能传其中一个，不允许二者都传。
EstablishedTimeout	Integer	否	四层Tcp监听的静默超时时间，默然值900s 取值区间[10, 900]。

返回参数


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

示例



请求示例

1.     https://slb.aliyuncs.com/
2.     &Action=CreateLoadBalancerTCPListener
3.     &LoadBalancerId=139a00604ad-cn-east-hangzhou-01
4.     &ListenerPort=443
5.     &BackendServerPort=443
6.     &Bandwidth=-1
7.     &VServerGroupId=rsp-cige6j5e7p
8.     &<公共请求参数>

返回示例

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