DescribeLoadBalancerHTTPSListenerAttribute_负载均衡_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

流控信息

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

授权信息

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

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
slb:DescribeLoadBalancerHTTPSListenerAttribute
Get
loadbalancer
acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}
slb:tag
slb:tag
slb:tag

请求参数

字段名称字段详情
RegionIdstring

传统型负载均衡实例的地域 ID。

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
LoadBalancerIdstring

传统型负载均衡实例的 ID。

示例值:lb-bp1mxu5r8lau****参考取值来源:
    CreateLoadBalancer
    DescribeLoadBalancers
ListenerPortinteger<int32>

实例前端使用的端口。展开详情

示例值:80取值 <= 65535

返回参数

字段名称字段详情
AclTypestring

访问控制类型:展开详情

示例值:white
XForwardedFor_ClientCertClientVerifystring

是否通过XForwardedFor_ClientCertClientVerify头字段获取对访问负载均衡实例客户端证书的校验结果。取值:展开详情

示例值:off
CACertificateIdstring

CA 证书 ID。

示例值:idkp-234-cn-test-0**
RequestIdstring

请求 ID。

示例值:365F4154-92F6-4AE4-92F8-7FF3********
HealthCheckConnectPortinteger<int32>

健康检查的端口。展开详情

示例值:8080
BackendServerPortinteger<int32>

实例后端使用的端口。

示例值:8080
CookieTimeoutinteger<int32>

Cookie 超时时间。

示例值:500
HealthCheckDomainstring

用于健康检查的域名。

示例值:www.test.com
XForwardedForstring

是否通过X-Forwarded-For的方式获取来访者真实 IP。取值:展开详情

示例值:on
XForwardedFor_ClientCertFingerprintstring

是否通过XForwardedFor_ClientCertFingerprint头字段获取访问负载均衡实例客户端证书的指纹。取值:展开详情

示例值:off
IdleTimeoutinteger<int32>

指定连接空闲超时时间,取值范围为 1~60,默认值为 15。单位:秒。展开详情

示例值:23
ListenerPortinteger<int32>

实例前端使用的端口。

示例值:80
HealthCheckURIstring

用于健康检查的 URI。

示例值:/test/index.html
XForwardedFor_SLBPORTstring

是否通过XForwardedFor_SLBPORT头字段获取负载均衡实例的监听端口。取值:展开详情

示例值:off
StickySessionTypestring

Cookie 的处理方式。展开详情

示例值:insert
Schedulerstring

调度算法。取值:wrrrr展开详情

示例值:wrr
XForwardedFor_protostring

是否通过X-Forwarded-Proto头字段获取负载均衡实例的监听协议。取值:展开详情

示例值:on
HealthCheckMethodstring

监听 HTTP 类型健康检查的健康检查方法。取值:headget展开详情

示例值:get
TLSCipherPolicystring

只有性能保障型实例才可以指定 TLSCipherPolicy 参数,每种 policy 定义了一种安全策略。展开详情

示例值:tls_cipher_policy_1_0
Statusstring

当前监听的状态。取值:展开详情

示例值:stopped
VServerGroupIdstring

绑定的服务器组 ID。

示例值:rsp-cige6j5e********
XForwardedFor_ClientSrcPortstring

是否通过XForwardedFor_ClientSrcPort头字段获取访问负载均衡实例客户端的端口。取值:展开详情

示例值:off
Cookiestring

服务器上配置的 Cookie。

示例值:testCookie
Gzipstring

是否开启Gzip压缩。取值:展开详情

示例值:on
EnableHttp2string

是否开启HTTP2特性。取值:展开详情

示例值:off
Bandwidthinteger<int32>

监听的带宽峰值。单位:Mbps。

示例值:10
Descriptionstring

自定义监听名称。

示例值:HTTPS_443
HealthCheckTimeoutinteger<int32>

每次健康检查响应的最大超时间。单位:秒。

示例值:3
AclStatusstring

是否开启访问控制功能。取值:展开详情

示例值:off
UnhealthyThresholdinteger<int32>

不健康检查阈值。

示例值:4
XForwardedFor_SLBIDstring

是否通过SLB-ID头字段获取负载均衡实例 ID。取值:展开详情

示例值:on
XForwardedFor_ClientCertSubjectDNstring

是否通过XForwardedFor_ClientCertSubjectDN头字段获取访问负载均衡实例客户端证书的所有者信息。取值:展开详情

示例值:off
SecurityStatusstring

是否处于安全状态。取值:展开详情

示例值:on
HealthCheckHttpCodestring

健康检查正常的 HTTP 状态码。

示例值:http_2xx,http_3xx
RequestTimeoutinteger<int32>

指定请求超时时间,取值范围为 1~180,默认值为 60。单位:秒。展开详情

示例值:43
HealthCheckIntervalinteger<int32>

健康检查的时间间隔。单位:秒。

示例值:5
ServerCertificateIdstring

服务器证书的 ID。

示例值:idkp-123-cn-test-0**
AclIdstring

监听绑定的访问策略组 ID。展开详情

示例值:acl-a2do9e413e0spzasx****
XForwardedFor_ClientCertIssuerDNstring

是否通过XForwardedFor_ClientCertIssuerDN头字段获取访问负载均衡实例客户端证书的发行者信息。取值:展开详情

示例值:off
HealthyThresholdinteger<int32>

健康检查阈值。

示例值:4
XForwardedFor_SLBIPstring

是否通过SLB-IP头字段获取客户端请求的 VIP(Virtual IP address)。取值:展开详情

示例值:on
StickySessionstring

是否开启会话保持。取值:展开详情

示例值:on
HealthCheckstring

是否开启健康检查。取值:展开详情

示例值:on
AclIdsobject
Rulesobject
DomainExtensionsobject
LoadBalancerIdstring

传统型负载均衡实例 ID。

示例值:lb-bp1mxu5r8lau****
Tagsobject

返回示例

变更历史

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

相关示例

创建UDP/TCP/HTTP/HTTPS监听、查询和修改监听的配置
2021-11-16