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

接口说明

前提条件

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

流控信息

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

授权信息

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

具体说明如下：展开详情

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

slb:DescribeLoadBalancerHTTPListenerAttribute	Get	loadbalancer acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}	slb:tag slb:tag slb:tag slb:tag	无

请求参数

字段名称	字段详情
RegionIdstring	传统型负载均衡实例的地域 ID。展开详情示例值:cn-hangzhou参考取值来源: DescribeRegions
LoadBalancerIdstring	传统型负载均衡实例的 ID。示例值:lb-bp1uaunez0uho0zf0****参考取值来源: CreateLoadBalancer DescribeLoadBalancers
ListenerPortinteger<int32>	实例前端使用的端口。展开详情示例值:80取值 <= 65535

返回参数

字段名称	字段详情
AclTypestring	访问控制类型：展开详情示例值:white
VServerGroupIdstring	绑定的服务器组 ID。示例值:rsp-cige6j****
Statusstring	当前监听的状态。取值：展开详情示例值:stopped
XForwardedFor_ClientSrcPortstring	是否通过`XForwardedFor_ClientSrcPort`头字段获取访问负载均衡实例客户端的端口。取值：展开详情示例值:off
Cookiestring	服务器上配置的 Cookie。示例值:testCookie
Gzipstring	是否开启`Gzip`压缩，对特定文件类型进行压缩。取值：展开详情示例值:on
HealthCheckConnectPortinteger<int32>	健康检查的端口。展开详情示例值:8080
RequestIdstring	请求 ID。示例值:365F4154-92F6-4AE4-92F8-7FF34B540710
Descriptionstring	自定义监听名称。示例值:HTTP_80
Bandwidthinteger<int32>	监听的带宽峰值。单位：Mbps。展开详情示例值:-1
HealthCheckTimeoutinteger<int32>	每次健康检查响应的超时时间，单位：秒。示例值:3
AclStatusstring	是否开启访问控制功能。取值：展开详情示例值:off
BackendServerPortinteger<int32>	实例后端使用的端口。示例值:80
CookieTimeoutinteger<int32>	Cookie 超时时间。单位：秒。示例值:500
HealthCheckDomainstring	用于健康检查的域名。示例值:www.domain.com
UnhealthyThresholdinteger<int32>	不健康检查阈值。示例值:4
ForwardPortinteger<int32>	HTTP 至 HTTPS 的监听转发端口。展开详情示例值:80
XForwardedFor_SLBIDstring	是否通过`SLB-ID`头字段获取负载均衡实例 ID。取值：展开详情示例值:on
SecurityStatusstring	是否开启安全状态。取值：展开详情示例值:on
HealthCheckHttpCodestring	健康检查正常的 HTTP 状态码。示例值:http_2xx,http_3xx
ListenerForwardstring	是否开启 HTTP 至 HTTPS 的监听转发。取值：展开详情示例值:on
XForwardedForstring	是否开启通过`X-Forwarded-For`头字段的方式获取来访者真实 IP。取值：展开详情示例值:on
IdleTimeoutinteger<int32>	指定连接空闲超时时间，单位：秒。展开详情示例值:2
RequestTimeoutinteger<int32>	指定请求超时时间。单位：秒。展开详情示例值:34
ListenerPortinteger<int32>	实例前端使用的端口。示例值:80
HealthCheckIntervalinteger<int32>	健康检查的时间间隔，单位：秒。示例值:5
XForwardedFor_SLBPORTstring	是否通过`XForwardedFor_SLBPORT`头字段获取负载均衡实例的监听端口。取值：展开详情示例值:off
HealthCheckURIstring	用于健康检查的 URI。展开详情示例值:/test/index.html
StickySessionTypestring	Cookie 的处理方式。展开详情示例值:insert
AclIdstring	监听绑定的访问策略组 ID。展开详情示例值:acl-uf60jw******
Schedulerstring	调度算法。取值：展开详情示例值:wrr
HealthyThresholdinteger<int32>	健康检查阈值。示例值:4
XForwardedFor_protostring	是否通过`X-Forwarded-Proto`头字段获取负载均衡实例的监听协议。取值：展开详情示例值:on
XForwardedFor_SLBIPstring	是否通过`SLB-IP`头字段获取客户端请求的 VIP（Virtual IP address）。取值：展开详情示例值:on
StickySessionstring	是否开启会话保持。取值：展开详情示例值:on
HealthCheckMethodstring	监听 HTTP 类型健康检查的健康检查方法。取值：head 或 get。展开详情示例值:get
HealthCheckstring	是否开启健康检查。取值：展开详情示例值:on
AclIdsobject
Rulesobject
LoadBalancerIdstring	传统型负载均衡实例 ID。示例值:lb-bp1uaunez0uho0zf0****
Tagsobject

返回示例

变更历史

	变更时间	变更内容概要	操作
	2024-05-28	变更返回参数
	2023-12-14	变更返回参数
	2022-12-14	变更返回参数

DescribeLoadBalancerHTTPListenerAttribute_负载均衡_API文档

接口说明

前提条件

流控信息

授权信息

请求参数

返回参数

返回示例

变更历史

相关示例