使用SetLoadBalancerTCPListenerAttribute API修改TCP监听配置-负载均衡-阿里云-负载均衡(SLB)-阿里云帮助中心

修改TCP监听的配置。

接口说明

您已经创建传统型负载均衡。具体操作，请参见 CreateLoadBalancer 。
您已经创建 TCP 监听。具体操作，请参见 CreateLoadBalancerTCPListener 。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

slb:SetLoadBalancerTCPListenerAttribute

update

*acl

acs:slb:{#regionId}:{#accountId}:acl/{#aclId}

*loadbalancer

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

slb:tag
slb:tag
slb:tag

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	传统型负载均衡实例的地域 ID。您可以从地域和可用区列表或通过调用 DescribeRegions 接口查询地域 ID。	cn-hangzhou
LoadBalancerId	string	是	传统型负载均衡实例 ID。	lb-bp1ygod3yctvg1y****
ListenerPort	integer	是	传统型负载均衡实例前端使用的端口。取值范围：1~65535。	80
Bandwidth	integer	否	监听的带宽峰值。单位：Mbps。取值：-1或 1~5120。 -1：对于按流量计费的公网负载均衡实例，可以将带宽峰值设置为-1，即不限制带宽峰值。 1~5120：对于按带宽计费的公网负载均衡实例，可以设置每个监听的带宽峰值，但所有监听的带宽峰值之和不能超过实例的带宽峰值。	43
Scheduler	string	否	调度算法。取值： wrr：权重值越高的后端服务器，被轮询到的概率也越高。 rr：按照访问顺序依次将外部请求依序分发到后端服务器。 sch：基于源 IP 地址的一致性哈希，相同的源地址会调度到相同的后端服务器。 tch：基于四元组的一致性哈希（源 IP、目的 IP、源端口和目的端口），相同的流会调度到相同的后端服务器。说明仅性能保障型实例支持 sch 和 tch 一致性哈希算法。 CLB 不支持 wrr 和 rr 算法变更为一致性哈希算法，也不支持一致性哈希算法互转。	wrr
PersistenceTimeout	integer	否	会话保持的超时时间。单位：秒，取值范围：0~3600。默认值：0，表示关闭会话保持。	0
EstablishedTimeout	integer	否	连接超时时间。单位：秒。取值范围：10~900。	500
HealthyThreshold	integer	否	健康检查连续成功多少次后，将后端服务器的健康检查状态由失败判定为成功。取值范围：2~10。	4
UnhealthyThreshold	integer	否	健康检查连续失败多少次后，将后端服务器的健康检查状态由成功判定为失败。取值范围：2~10。	4
HealthCheckConnectTimeout	integer	否	接收来自运行状况检查的响应需要等待的时间。单位：秒，取值范围：1~300。如果后端 ECS 在指定的时间内没有正确响应，则判定为健康检查失败。说明如果该值小于 HealthCheckInterval 的值，则该值无效，超时时间为 HealthCheckInterval 的值。	100
HealthCheckConnectPort	integer	否	健康检查使用的端口。取值范围：1~65535。不设置此参数时，表示使用 BackendServerPort（后端服务端口）。	8080
HealthCheckInterval	integer	否	健康检查的时间间隔。单位：秒。取值范围：1~50。	5
HealthCheckDomain	string	否	用于健康检查的域名。当 TCP 监听需要使用 HTTP 健康检查时可配置此参数，如不配置则按 TCP 健康检查。 $_ip：后端服务器的私网 IP。当指定了 IP 或该参数未指定时，负载均衡会使用后端服务器的私网 IP 当做健康检查使用的域名。 domain：域名，长度为 1~80 个字符，支持字母、数字、半角句号（.）和短划线（-）。	192.168.XX.XX
HealthCheckURI	string	否	用于健康检查的 URI。长度为 1~80 个字符，支持字母、数字和短划线（-）、正斜线（/）、半角句号（.）、百分号（%）、半角问号（?）、井号（#）和 and（&）这些字符。URI 不能只为正斜线（/），但必须以正斜线（/）开头。当 TCP 监听需要使用 HTTP 健康检查时，可配置此参数。如不配置，则使用 TCP 健康检查。	/test/index.html
HealthCheckHttpCode	string	否	健康检查正常的 HTTP 状态码，多个状态码用半角逗号（,）分割。取值：http_2xx、http_3xx、http_4xx或http_5xx。	http_2xx
HealthCheckType	string	否	健康检查类型。取值：tcp 或 http。	tcp
SynProxy	string	否	是否开启负载均衡的攻击防护功能 SynProxy。取值： enable：开启。 disable：不开启。建议一般情况下不要调整这个参数，由负载均衡控制。	enable
VServerGroup	string	否	是否使用虚拟服务器组。取值： on：使用。 off：不使用。说明 VserverGroup 和 MasterSlaveServerGroup 只允许一个值为 on。	on
VServerGroupId	string	否	虚拟服务器组 ID。	rsp-cige6j5****
MasterSlaveServerGroupId	string	否	主备服务器组 ID。说明虚拟服务器组 ID 和主备服务器组 ID 只能选择一个。	rsp-cige****
MasterSlaveServerGroup	string	否	是否使用主备服务器组。取值： on：使用。 off：不使用。 VserverGroup 和 MasterSlaveServerGroup 只允许一个值为 on。	on
AclId	string	否	监听绑定的访问策略组 ID。当 AclStatus 参数值为 on 时，该参数必选。	12333
AclType	string	否	访问控制类型。取值： white：仅转发来自所选访问控制策略组中设置的 IP 地址或地址段的请求，白名单适用于只允许特定 IP 访问的场景。设置白名单存在一定业务风险。一旦设置白名单，就只有白名单中的 IP 可以访问负载均衡监听。如果开启了白名单访问，但访问策略组中没有添加任何 IP，则负载均衡监听会转发全部请求。 black：不会转发来自所选访问控制策略组中设置的 IP 地址或地址段，黑名单适用于只限制某些特定 IP 访问的场景。如果开启了黑名单访问，但访问策略组中没有添加任何 IP，则负载均衡监听会转发全部请求。说明当 AclStatus 参数的值为 on 时，该参数有效。	white
AclStatus	string	否	是否开启访问控制功能。取值： on：开启访问控制。 off：关闭访问控制。	off
Description	string	否	自定义监听名称。长度限制为 1~256 个字符，支持中文、字母、数字、短划线（-）、正斜线（/）、半角句号（.）和下划线（_）。	tcp_80
ConnectionDrain	string	否	是否开启连接优雅中断。取值： on：开启。 off：不开启。	off
ConnectionDrainTimeout	integer	否	设置连接优雅中断超时时间。当 ConnectionDrain 取值为 on 时，该选项必选。单位：秒。取值范围：10~900。	300
ProxyProtocolV2Enabled	boolean	否	是否支持通过 Proxy Protocol 协议携带客户端源地址到后端服务器。取值： true：是。 false：否。	false
HealthCheckSwitch	string	否	是否开启健康检查。取值： on：开启。 off：不开启。	on

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	CEF72CEB-54B6-4AE8-B225-F876FF7BA984

示例

正常返回示例

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameterValue.SpecNotSupport	The loadBalancer of shared spec does not support the parameter value, %s.	共享型负载均衡实例不支持指定的参数取值。
400	OperationNotSupport.Acl	The cloud box instance does not support acl.	云盒实例不支持配置访问控制。
400	InvalidParameterValue.RegionNotSupport	The region does not support the parameter value, %s.	当前地域不支持指定的参数取值。
400	IpVersionConflict	The ip version of this LoadBalancer and the Acl is conflict.	指定负载均衡的IP版本与ACL支持的IP类型冲突。
400	InvalidParameterValue.ZoneNotSupport	The zone does not support the parameter value, %s.	当前可用区不支持指定参数取值。
400	InvalidParameter.ZoneNotSupport	The zone does not support the parameter %s.	当前可用区不支持指定参数。
400	OperationFailed.ServerGroupInUse	The VServerGroup or MasterSlaveServerGroup can not be close for this listener.	操作失败，原因是当前监听不支持关闭服务器组。
400	InvalidParam.VServerGroupId	The specified VServerGroupId is invalid.	指定的VServerGroupId无效。请检查参数约束，并在修改后重试。
400	MissingParam.HealthCheckConnectPort	The parameter HealthCheckConnectPort is required.	参数HealthCheckConnectPort缺失。
400	InvalidParam.ListenerPort	The specified ListenerPort is invalid.	指定的ListenerPort无效。请检查参数约束，并在修改后重试。
400	InvalidParam.StartPort	The specified StartPort is invalid.	指定的StartPort无效。请检查参数约束，并在修改后重试。
400	InvalidParamSize.PortRange	The size of param PortRange is invalid.	指定的PortRange无效。请检查参数约束，并在修改后重试。
400	InvalidParam.EndPort	The specified EndPort is invalid.	指定的EndPort无效。请检查参数约束，并在修改后重试。
400	InvalidParam.PortRange	The specified PortRange is invalid.	指定的PortRange无效。请检查参数约束，并在修改后重试。
400	Duplicated.AclEntry	%s.	%s
400	ResourceNotFound.VServerGroup	%s.	指定的服务器组不存在。
400	IllegalParam.FailoverStrategy	The parameter FailoverStrategy is illegal.	指定的FailoverStrategy无效。请检查参数约束，并在修改后重试。
400	IllegalParam.FailoverThreshold	The parameter FailoverThreshold is illegal.	指定的FailoverThreshold无效。请检查参数约束，并在修改后重试。
400	MasterSlaveServerConflict	The servers are conflict for MasterSlaveGroup.	主备服务器组的后端服务器冲突。
400	MissingParam.VServerGroupId	The parameter VServerGroupId is missing.	参数VServerGroupId缺失。
400	OperationDenied.HealthCheckClosedForMasterSlaveMode	The operation is denied because of HealthCheckClosedForMasterSlaveMode.	操作被拒绝，原因是主备模式下要求必须开启健康检查。
400	InvalidParam.HealthCheck	The param of HealthCheck is illegal.	指定的HealthCheck无效。请检查参数约束，并在修改后重试。
400	OperationDenied.MasterSlaveGroupLogEnabled	The operation is denied because of MasterSlaveGroupLogEnabled.	操作被拒绝，原因是主备服务器组日志已启用。
400	OperationDenied.NotSupportAcl	The operation is denied because The single Tunnel or any Tunnel loadbalancer does not support config AccessControlList.	操作被拒绝，原因是Single Tunnel和Any Tunnel 类型负载均衡实例不支持配置Acl。
400	OperationDenied.FullNatModeNotAllowed	The operation is not allowed because of FullNatModeNotAllowed.	操作被拒绝，原因是不支持FullNat模式。
400	OperationDenied.OnlyIpv4SlbSupport	The operation is not allowed because of OnlyIpv4SlbSupport.	操作被拒绝，原因是只有IPV4实例支持开启FULL NAT模式。
400	SpecNotSupportParameter	The instance with share spec does not support FullNatEnabled parameter.	共享型实例不支持FullNatEnabled参数。
400	Abs.VServerGroupIdAndMasterSlaveServerGroupId.MissMatch	Virtual service group ID or master slave server group ID is missing. Please check the input parameters.	虚拟服务组ID或者主备服务器组ID缺失，请检查输入参数。
400	AclListenerOverLimit	This acl has reached the limit of binding to listeners.	指定Acl可关联监听数量已达到配额上限。
400	QuotaLimitExceeds.AclAttachedToListener	The number of Acl bound listeners has reached the quota limit	Acl绑定监听数已达到配额上限。
400	QuotaLimitExceeds.TotalAclEntry	The number of Acl entries has reached the quota limit.	Acl条目数已达到配额上限。
400	QuotaLimitExceeds.AclListenerOverLimit	This acl has reached the limit of binding to listeners.	指定Acl可关联监听数量已达到配额上限。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。