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

接口说明

前提条件

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

请求参数

字段名称	字段详情
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

变更历史

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