Skip to Content
网路负载均衡 NLB更新监听器属性 - UpdateNLBListenerAttribute

更新监听器属性 - UpdateNLBListenerAttribute

简介

更新监听器属性

定义

公共参数

参数名类型描述信息必填
Actionstring对应的 API 指令名称,当前 API 为 UpdateNLBListenerAttributeYes
PublicKeystring用户公钥,可从 控制台 获取Yes
Signaturestring根据公钥及 API 指令生成的用户签名,参见 签名算法Yes

请求参数

参数名类型描述信息必填
Regionstring地域。 参见 地域和可用区列表Yes
ProjectIdstring项目ID。不填写为默认项目,子帐号必须填写。 请参考GetProjectList接口No
NLBIdstring负载均衡实例的IDYes
ListenerIdstring负载均衡实例的IDYes
Namestring监听器的名称No
Remarkstring监听器的备注信息No
StartPortint端口范围的起始端口 限定取值:[1-65535] 默认值 1,只有全端口模式支持修改No
EndPortint端口范围的结束端口 限定取值:[1-65535] 取值不小于起始端口 默认值 65535,只有全端口模式支持修改No
Schedulerstring负载均衡算法
限定取值:“RoundRobin”/“SourceHash”/“LeastConn”/“WeightLeastConn ”/“WeightRoundRobin” 默认值 “RoundRobin”
No
StickinessTimeoutint会话保持超时时间。单位:秒
说明:
限定取值:[60-900],0 表示不开启会话保持
默认值60
No
ForwardSrcIPMethodstring传递源 IP 方法。限定取值:"" / “None” / “Toa”,空字符串和 None 代表关闭。No
HealthCheckConfig.Enabledboolean是否开启健康检查功能。暂时不支持关闭,默认 trueNo
HealthCheckConfig.Portint健康检查探测端口 说明: 限定取值:[1-65535]
No
HealthCheckConfig.Typestring健康检查方式 限定取值:“Port”/“UDP”/“Ping” 默认值:“Port”No
HealthCheckConfig.ReqMsgstringUDP” 检查模式的请求字符串No
HealthCheckConfig.ResMsgstring”UDP” 检查模式的预期响应字符串No

响应字段

字段名类型描述信息必填
RetCodeint返回状态码,为 0 则为成功返回,非 0 为失败Yes
Actionstring操作指令名称Yes
Messagestring返回错误消息,当 RetCode 非 0 时提供详细的描述信息No

示例

请求示例

https://api.an-link.com/?Action=UpdateNLBListenerAttribute &Region=cn-zj &Zone=cn-zj-01 &ProjectId=lYIktcFh &NLBId=WSAPopZX &ListenerId=FeUBtqTg &Name=BkVDOGZZ &Remark=zjRVFQVu &Scheduler=RgCTjVdZ &StickinessTimeout=6 &HealthCheckConfig=pSNguzLp &StartPort=9 &EndPort=4 &HealthCheckConfig.Port=1 &HealthCheckConfig.Type=wvhRZsuN &HealthCheckConfig.Interval=3 &HealthCheckConfig.MinSuccess=7 &HealthCheckConfig.MaxFail=3 &HealthCheckConfig.ReqMsg=tEjwkHxq &HealthCheckConfig.ResMsg=AJXQCEfb &ForwardSrcIPMethod=ZigBubeF

响应示例

{ "Action": "UpdateNLBListenerAttributeResponse", "RetCode": 0 }