创建监听器 - CreateNLBListener

简介

创建监听器

定义

公共参数

参数名	类型	描述信息	必填
Action	string	对应的 API 指令名称，当前 API 为 `CreateNLBListener`	Yes
PublicKey	string	用户公钥，可从控制台获取	Yes
Signature	string	根据公钥及 API 指令生成的用户签名，参见签名算法	Yes

请求参数

参数名	类型	描述信息	必填
Region	string	地域。参见地域和可用区列表	Yes
ProjectId	string	项目ID。不填写为默认项目，子帐号必须填写。请参考GetProjectList接口	No
NLBId	string	负载均衡实例的ID	Yes
Protocol	string	监听协议限定取值：“TCP”/“UDP”	Yes
HealthCheckConfig.Port	int	健康检查探测端口说明：限定取值：[1-65535]，Ping 探测下，端口可填 0	Yes
HealthCheckConfig.Enabled	boolean	是否开启健康检查功能。暂时不支持关闭，默认 true	No
HealthCheckConfig.Type	string	健康检查方式限定取值：“Port”/“UDP”/“Ping” 默认值：“Port”，Ping 只允许 UDP 协议监听器设置	No
HealthCheckConfig.ReqMsg	string	UDP” 检查模式的请求字符串	No
HealthCheckConfig.ResMsg	string	”UDP” 检查模式的预期响应字符串	No
Name	string	监听器的名称限定字符长度：[1-255] 限定特殊字符，仅支持：-_. 默认值：listener	No
Remark	string	监听器的备注信息限定字符长度：[0-255]	No
StartPort	int	端口范围的起始端口限定取值：[1-65535] 默认值 1	No
EndPort	int	端口范围的结束端口限定取值：[1-65535] 取值不小于起始端口默认值 65535	No
Scheduler	string	负载均衡算法限定取值：“RoundRobin”/“SourceHash”/“LeastConn”/“WeightLeastConn ”/“WeightRoundRobin” 默认值 “RoundRobin”	No
StickinessTimeout	int	会话保持超时时间。单位：秒限定取值：[60-900]，0 表示不开启会话保持默认值60	No
ForwardSrcIPMethod	string	传递源 IP 方法。限定取值："" / “None” / “Toa”/“ProxyProto”，空字符串和 None 代表关闭。	No

响应字段

字段名	类型	描述信息	必填
RetCode	int	返回状态码，为 0 则为成功返回，非 0 为失败	Yes
Action	string	操作指令名称	Yes
Message	string	返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息	No
ListenerId	string	监听器的ID	Yes

示例

请求示例


https://api.tnqacloud.com/?Action=CreateNLBListener
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=MARULUOv
&NLBId=GNvXptgc
&Name=LtMcdpyQ
&Remark=urkacxDK
&StartPort=5
&EndPort=4
&Protocol=vfTQAfIi
&Scheduler=mYCNnjfx
&StickinessTimeout=7
&HealthCheckConfig=WHmazuVn
&HealthCheckConfig.Port=7
&HealthCheckConfig.Type=OTsPFkqI
&HealthCheckConfig.Interval=3
&HealthCheckConfig.MinSuccess=8
&HealthCheckConfig.MaxFail=5
&HealthCheckConfig.ReqMsg=AQIXJQZS
&HealthCheckConfig.ResMsg=bBBpmaEy
&ForwardSrcIPMethod=aRYJWQFx

响应示例


{
  "Action": "CreateNLBListenerResponse",
  "ListenerId": "WVmnGcQN",
  "RetCode": 0
}