SetLoadBalancerHTTPListenerAttribute_负载均衡_API文档-阿里云OpenAPI开发者门户

接口说明

前提条件

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

流控信息

请求速率为90/60(s)。更多流控信息，请前往配额中心查看

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

slb:SetLoadBalancerHTTPListenerAttribute	Update	acl acs:slb:{#regionId}:{#accountId}:acl/{#aclId} loadbalancer acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}	slb:tag slb:tag slb:tag	无

请求参数

字段名称	字段详情
RegionIdstring	负载均衡实例的地域 ID。展开详情示例值:cn-hangzhou参考取值来源: DescribeRegions
LoadBalancerIdstring	负载均衡实例的 ID。示例值:lb-bp1qjwo61pqz3ah*****参考取值来源: CreateLoadBalancer DescribeLoadBalancers
ListenerPortinteger<int32>	负载均衡实例前端使用的端口。展开详情示例值:80取值 <= 65535
Bandwidthinteger<int32>	监听的带宽峰值。单位：Mbps。取值：展开详情示例值:-1取值 <= 5120
XForwardedForstring	是否通过`X-Forwarded-For`头字段获取客户端请求的真实 IP。取值：展开详情示例值:on
Schedulerstring	调度算法。取值：展开详情示例值:wrr
StickySessionstring	是否开启会话保持。取值：展开详情示例值:on
StickySessionTypestring	Cookie 的处理方式。取值：展开详情示例值:insert
CookieTimeoutinteger<int32>	Cookie 超时时间。展开详情示例值:500取值 <= 86400
Cookiestring	服务器上配置的 Cookie。展开详情示例值:testCookie
HealthCheckstring	是否开启健康检查。取值：展开详情示例值:on
HealthCheckMethodstring	监听 HTTP 类型健康检查的健康检查方法。取值：head 或 get。展开详情示例值:get
HealthCheckDomainstring	用于健康检查的域名，取值：展开详情示例值:172.XX.XX.16
HealthCheckURIstring	用于健康检查的 URI。展开详情示例值:/test/index.html
HealthyThresholdinteger<int32>	健康检查连续成功多少次后，将后端服务器的健康检查状态由 fail 判定为 success。展开详情示例值:4取值 <= 10
UnhealthyThresholdinteger<int32>	健康检查连续失败多少次后，将后端服务器的健康检查状态由 success 判定为 fail。展开详情示例值:4取值 <= 10
HealthCheckTimeoutinteger<int32>	接收来自运行状况检查的响应需要等待的时间。如果后端 ECS 在指定的时间内没有正确响应，则判定为健康检查失败。在 HealthCheck 值为 on 时才会有效。展开详情示例值:3取值 <= 300
HealthCheckIntervalinteger<int32>	健康检查的时间间隔。展开详情示例值:5取值 <= 50
HealthCheckConnectPortinteger<int32>	健康检查使用的端口。展开详情示例值:8080取值 <= 65535
HealthCheckHttpCodestring	健康检查正常的 HTTP 状态码，多个状态码用半角逗号（,）分割。展开详情示例值:http_2xx,http_3xx
VServerGroupstring	是否使用虚拟服务器组。取值：展开详情示例值:on参考取值来源: CreateVServerGroup DescribeVServerGroups SetVServerGroupAttribute AddVServerGroupBackendServers ModifyVServerGroupBackendServers RemoveVServerGroupBackendServers
VServerGroupIdstring	虚拟服务器组 ID。示例值:rsp-cige6j*****参考取值来源: CreateVServerGroup DescribeVServerGroups SetVServerGroupAttribute AddVServerGroupBackendServers ModifyVServerGroupBackendServers RemoveVServerGroupBackendServers
XForwardedFor_SLBIPstring	是否通过`SLB-IP`头字段获取客户端请求的 VIP（Virtual IP address）。取值：展开详情示例值:on
XForwardedFor_SLBIDstring	是否通过`SLB-ID`头字段获取负载均衡实例 ID。取值：展开详情示例值:on参考取值来源: DescribeLoadBalancerListeners
XForwardedFor_protostring	是否通过`X-Forwarded-Proto`头字段获取负载均衡实例的监听协议。取值：展开详情示例值:on
Gzipstring	是否开启`Gzip`压缩，对特定文件类型进行压缩。取值：展开详情示例值:on
AclIdstring	监听绑定的访问策略组 ID。展开详情示例值:acl-uf60jw******
AclTypestring	访问控制类型：展开详情示例值:white
AclStatusstring	是否开启访问控制功能。取值：展开详情示例值:off
IdleTimeoutinteger<int32>	指定连接空闲超时时间，取值范围为1~60秒，默认值为 15 秒。展开详情示例值:12取值 <= 9999
RequestTimeoutinteger<int32>	指定请求超时时间，取值范围为1~180秒，默认值为 60 秒。展开详情示例值:3取值 <= 9999
Descriptionstring	设置监听的描述信息。示例值:test
XForwardedFor_SLBPORTstring	是否通过`XForwardedFor_SLBPORT`头字段获取负载均衡实例的监听端口。取值：展开详情示例值:off
XForwardedFor_ClientSrcPortstring	是否通过`XForwardedFor_ClientSrcPort`头字段获取访问负载均衡实例客户端的端口。取值：展开详情示例值:off

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:CEF72CEB-54B6-4AE8-B225-F876FF7BA984

返回示例

错误返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	IpVersionConflict	The ip version of this LoadBalancer and the Acl is conflict.	诊断
400	Operation.NotAllowed	Operation Denied. The HTTP listener does not support this action.	诊断
400	InvalidParameter.IdleTimeout	The specified IdleTimeout exceeds the limit.	诊断
400	InvalidParameter.RequestTimeout	The specified RequestTimeout exceeds the limit.	诊断
400	ListenerForwardNotSupport	X-Forward-For is not supported to a ipv6 instance.	诊断
400	InvalidParameter.RegionNotSupport	The region does not support the parameter: %s.	诊断
400	OperationFailed.ServerGroupInUse	The VServerGroup or MasterSlaveServerGroup can not be close for this listener.	诊断
400	InvalidParameter.VServerGroupId	The MasterSlaveServerGroup can not be attached to HTTP or HTTPS listener.	诊断
400	MissingParam.HealthCheckDomain	The HealthCheckDomain is required when HealthCheckHttpVersion is http1.1.	诊断
400	InvalidParameter.HealthCheckHttpVersion	The param HealthCheckHttpVersion is invalid.	诊断
400	Duplicated.AclEntry	%s.	诊断
400	InvalidParameter.ForwardCode	The specified ForwardCode is invalid.	诊断
400	AclListenerOverLimit	This acl has reached the limit of binding to listeners.	诊断
400	QuotaLimitExceeds.AclAttachedToListener	The number of Acl bound listeners has reached the quota limit	诊断
400	QuotaLimitExceeds.TotalAclEntry	The number of Acl entries has reached the quota limit.	诊断
400	QuotaLimitExceeds.AclListenerOverLimit	This acl has reached the limit of binding to listeners.	诊断

变更历史

	变更时间	变更内容概要	操作
	2025-02-11	变更错误码400
	2025-01-08	变更错误码400
	2023-12-14	新增请求参数XForwardedFor_SLBPORT 新增请求参数XForwardedFor_ClientSrcPort

SetLoadBalancerHTTPListenerAttribute_负载均衡_API文档

接口说明

前提条件

流控信息

授权信息

请求参数

返回参数

返回示例

错误返回示例

错误码

变更历史

相关示例