调用DescribeLoadBalancerHTTPSListenerAttribute查询HTTPS监听配置。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeLoadBalancerHTTPSListenerAttribute

要执行的操作。

取值:DescribeLoadBalancerHTTPSListenerAttribute

ListenerPort Integer 80

负载均衡实例前端使用的端口。

取值:1~65535

LoadBalancerId String lb-bp1mxu5r8lau****

负载均衡实例的ID。

RegionId String cn-hangzhou

负载均衡实例的地域ID。

返回数据

名称 类型 示例值 描述
ListenerPort Integer 80

负载均衡实例前端使用的端口。

BackendServerPort Integer 80

负载均衡实例后端使用的端口。

Bandwidth Integer -1

监听的带宽峰值。

Status String stopped

当前监听的状态。

取值:runningstopped

XForwardedFor String on

通过X-Forwarded-For的方式获取来访者真实IP。

取值:onoff

Scheduler String wrr

调度算法。

取值:wrrrr

  • wrr(默认值):权重值越高的后端服务器,被轮询到的次数(概率)也越高。
  • rr:按照访问顺序依次将外部请求依序分发到后端服务器。
StickySession String on

开启会话保持。

取值:onoff

StickySessionType String insert

Cookie的处理方式。当StickySession的值为on时,必须指定该参数。

取值:insertserver

  • insert:植入Cookie。

    客户端第一次访问时,负载均衡会在返回请求中植入Cookie(即在HTTP/HTTPS响应报文中插入SERVERID),下次客户端携带此Cookie访问,负载均衡服务会将请求定向转发给之前记录到的后端服务器上。

  • server:重写Cookie。

    负载均衡发现用户自定义了Cookie,将会对原来的Cookie进行重写,下次客户端携带新的Cookie访问,负载均衡服务会将请求定向转发给之前记录到的后端服务器。

说明StickySession的值为on时,必须指定该参数。
CookieTimeout Integer 500

Cookie超时时间。

Cookie String B490B5EBF6F3CD402E515D22BCDA1598

服务器上配置的Cookie。

HealthCheck String on

开启健康检查。

取值:onoff

HealthCheckDomain String www.test.com

用于健康检查的域名。

HealthCheckURI String /test/index.html

用于健康检查的URI。

长度限制为1~80,只能使用字母、数字和-/.%?#&这些字符。 URL不能只为/,但必须以/开头。

HealthyThreshold Integer 4

健康检查阈值。

UnhealthyThreshold Integer 4

不健康检查阈值。

HealthCheckTimeout Integer 3

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

HealthCheckInterval Integer 5

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

HealthCheckHttpCode String http_2xx,http_3xx

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

HealthCheckConnectPort Integer 8080

健康检查的端口。

说明HealthCheck值为on时才会有效。
ServerCertificateId String idkp-123-cn-test-0**

服务器证书的ID。

CACertificateId String idkp-234-cn-test-0**

CA证书ID。

VServerGroupId String rsp-cige6j5e********

绑定的服务器组ID。

Gzip String on

开启Gzip压缩。

取值:onoff

AclId String nacl-a2do9e413e0spzasx****

监听绑定的访问策略组ID。

AclStatus参数的值为on时,该参数必选。

AclStatus String off

开启访问控制功能。

取值:onoff(默认值)。

AclType String white

访问控制类型:

  • white: 仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求,白名单适用于应用只允许特定IP访问的场景。设置白名单存在一定业务风险。一旦设置白名单,就只有白名单中的IP可以访问负载均衡监听。

    如果开启了白名单访问,但访问策略组中没有添加任何IP,则负载均衡监听不会转发任何请求。

  • black: 来自所选访问控制策略组中设置的IP地址或地址段的所有请求都不会转发,黑名单适用于应用只限制某些特定IP访问的场景。

    如果开启了黑名单访问,但访问策略组中没有添加任何IP,则负载均衡监听会转发全部请求。

AclStatus参数的值为on时,该参数必选。

Description String 监听描述

监听描述。

DomainExtensions Array of DomainExtension

域名扩展列表。

DomainExtension
Domain String www.example.com

域名。

DomainExtensionId String 12

域名扩展ID。

ServerCertificateId String 13344444****

与域名对应的证书ID。

EnableHttp2 String off

开启HTTP2特性。

取值:on(默认值)或off

IdleTimeout Integer 23

指定连接空闲超时时间,取值范围为1~60秒,默认值为15秒。

在超时时间内一直没有访问请求,负载均衡会暂时中断当前连接,直到一下次请求来临时重新建立新的连接。

RequestId String 365F4154-92F6-4AE4-92F8-7FF3********

请求ID。

RequestTimeout Integer 43

指定请求超时时间,取值范围为1~180秒,默认值为60秒。

在超时时间内后端服务器一直没有响应,负载均衡将放弃等待,给客户端返回HTTP 504错误码。

Rules Array of Rule

监听下的转发规则列表。

Rule
Domain String www.example.com

域名。

RuleId String 23

转发规则ID。

RuleName String example

转发规则名称。

Url String /example

访问路径。

VServerGroupId String 12

转发规则的目标服务器组ID。

SecurityStatus String on

安全状态。

取值:onoff

TLSCipherPolicy String tls_cipher_policy_1_0

只有性能保障型实例才可以指定TLSCipherPolicy参数,每种policy定义了一种安全策略,安全策略包含HTTPS可选的TLS协议版本和配套的加密算法套件。

目前支持以下四种安全策略,详细区别请参见TLS安全策略差异说明,请根据实际情况选择对应的policy。

  • tls_cipher_policy_1_0

    支持TLS版本: TLSv1.0、TLSv1.1和TLSv1.2。

    支持加密算法套件:ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA和DES-CBC3-SHA。

  • tls_cipher_policy_1_1

    支持TLS版本: TLSv1.1和TLSv1.2。

    支持加密算法套件:ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA和DES-CBC3-SHA。

  • tls_cipher_policy_1_2

    支持TLS版本:TLSv1.2。

    支持加密算法套件:ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA和DES-CBC3-SHA。

  • tls_cipher_policy_1_2_strict

    支持TLS版本:TLSv1.2。

    支持加密算法套件:ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-RSA-AES128-SHA和ECDHE-RSA-AES256-SHA。

XForwardedFor_ClientCertClientVerify String off

通过XForwardedFor_ClientCertClientVerify头字段获取对访问负载均衡实例客户端证书的校验结果。

取值:onoff

XForwardedFor_ClientCertFingerprint String off

通过XForwardedFor_ClientCertFingerprint头字段获取访问负载均衡实例客户端证书的指纹。

取值:onoff

XForwardedFor_ClientCertIssuerDN String off

通过XForwardedFor_ClientCertIssuerDN头字段获取访问负载均衡实例客户端证书的发行者信息。

取值:onoff

XForwardedFor_ClientCertSubjectDN String off

通过XForwardedFor_ClientCertSubjectDN头字段获取访问负载均衡实例客户端证书的所有者信息。

取值:onoff

XForwardedFor_ClientSrcPort String off

通过XForwardedFor_ClientSrcPort头字段获取访问负载均衡实例客户端的端口。

取值:onoff

XForwardedFor_SLBID String on

通过SLB-ID头字段获取负载均衡实例ID。

取值:onoff

XForwardedFor_SLBIP String on

通过SLB-IP头字段获取客户端请求的真实IP。

取值:onoff

XForwardedFor_SLBPORT String off

通过XForwardedFor_SLBPORT头字段获取负载均衡实例的监听端口。

取值:onoff

XForwardedFor_proto String on

通过X-Forwarded-Proto头字段获取负载均衡实例的监听协议。

取值:onoff

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeLoadBalancerHTTPSListenerAttribute
&ListenerPort=80
&LoadBalancerId=lb-bp1mxu5r8lau****
&<公共请求参数>

正常返回示例

XML格式

<CookieTimeout>500</CookieTimeout>
<VServerGroupId>rsp-cige6j5e********</VServerGroupId>
<Description>监听描述</Description>
<UnhealthyThreshold>4</UnhealthyThreshold>
<HealthCheckURI>/test/index.html</HealthCheckURI>
<Scheduler>wrr</Scheduler>
<HealthCheck>on</HealthCheck>
<DomainExtensions>
    <DomainExtension>
        <DomainExtensionId>12</DomainExtensionId>
        <ServerCertificateId>13344444****</ServerCertificateId>
        <Domain>www.example.com</Domain>
    </DomainExtension>
</DomainExtensions>
<IdleTimeout>23</IdleTimeout>
<BackendServerPort>80</BackendServerPort>
<XForwardedFor_SLBID>on</XForwardedFor_SLBID>
<XForwardedFor_SLBPORT>off</XForwardedFor_SLBPORT>
<HealthCheckConnectPort>8080</HealthCheckConnectPort>
<SecurityStatus>on</SecurityStatus>
<Bandwidth>-1</Bandwidth>
<Gzip>on</Gzip>
<ServerCertificateId>idkp-123-cn-test-0**</ServerCertificateId>
<StickySessionType>insert</StickySessionType>
<XForwardedFor_SLBIP>on</XForwardedFor_SLBIP>
<HealthCheckHttpCode>http_2xx,http_3xx</HealthCheckHttpCode>
<Cookie>B490B5EBF6F3CD402E515D22BCDA1598</Cookie>
<Status>stopped</Status>
<RequestTimeout>43</RequestTimeout>
<ListenerPort>80</ListenerPort>
<TLSCipherPolicy>tls_cipher_policy_1_0</TLSCipherPolicy>
<HealthCheckInterval>5</HealthCheckInterval>
<RequestId>365F4154-92F6-4AE4-92F8-7FF3********</RequestId>
<CACertificateId>idkp-234-cn-test-0**</CACertificateId>
<XForwardedFor_ClientCertSubjectDN>off</XForwardedFor_ClientCertSubjectDN>
<AclId>nacl-a2do9e413e0spzasx****</AclId>
<HealthCheckTimeout>3</HealthCheckTimeout>
<Rules>
    <Rule>
        <VServerGroupId>12</VServerGroupId>
        <RuleId>23</RuleId>
        <Domain>www.example.com</Domain>
        <Url>/example</Url>
        <RuleName>example</RuleName>
    </Rule>
</Rules>
<XForwardedFor_ClientCertIssuerDN>off</XForwardedFor_ClientCertIssuerDN>
<StickySession>on</StickySession>
<AclStatus>off</AclStatus>
<HealthyThreshold>4</HealthyThreshold>
<XForwardedFor_ClientSrcPort>off</XForwardedFor_ClientSrcPort>
<XForwardedFor>on</XForwardedFor>
<HealthCheckDomain>www.test.com</HealthCheckDomain>
<AclType>white</AclType>
<XForwardedFor_proto>on</XForwardedFor_proto>
<EnableHttp2>off</EnableHttp2>
<XForwardedFor_ClientCertClientVerify>off</XForwardedFor_ClientCertClientVerify>
<XForwardedFor_ClientCertFingerprint>off</XForwardedFor_ClientCertFingerprint>

JSON格式

{
    "CookieTimeout": 500,
    "VServerGroupId": "rsp-cige6j5e********",
    "Description": "监听描述",
    "UnhealthyThreshold": 4,
    "HealthCheckURI": "/test/index.html",
    "Scheduler": "wrr",
    "HealthCheck": "on",
    "DomainExtensions": {
        "DomainExtension": {
            "DomainExtensionId": 12,
            "ServerCertificateId": "13344444****",
            "Domain": "www.example.com"
        }
    },
    "IdleTimeout": 23,
    "BackendServerPort": 80,
    "XForwardedFor_SLBID": "on",
    "XForwardedFor_SLBPORT": "off",
    "HealthCheckConnectPort": 8080,
    "SecurityStatus": "on",
    "Bandwidth": -1,
    "Gzip": "on",
    "ServerCertificateId": "idkp-123-cn-test-0**",
    "StickySessionType": "insert",
    "XForwardedFor_SLBIP": "on",
    "HealthCheckHttpCode": "http_2xx,http_3xx",
    "Cookie": "B490B5EBF6F3CD402E515D22BCDA1598",
    "Status": "stopped",
    "RequestTimeout": 43,
    "ListenerPort": 80,
    "TLSCipherPolicy": "tls_cipher_policy_1_0",
    "HealthCheckInterval": 5,
    "RequestId": "365F4154-92F6-4AE4-92F8-7FF3********",
    "CACertificateId": "idkp-234-cn-test-0**",
    "XForwardedFor_ClientCertSubjectDN": "off",
    "AclId": "nacl-a2do9e413e0spzasx****",
    "HealthCheckTimeout": 3,
    "Rules": {
        "Rule": {
            "VServerGroupId": 12,
            "RuleId": 23,
            "Domain": "www.example.com",
            "Url": "/example",
            "RuleName": "example"
        }
    },
    "XForwardedFor_ClientCertIssuerDN": "off",
    "StickySession": "on",
    "AclStatus": "off",
    "HealthyThreshold": 4,
    "XForwardedFor_ClientSrcPort": "off",
    "XForwardedFor": "on",
    "HealthCheckDomain": "www.test.com",
    "AclType": "white",
    "XForwardedFor_proto": "on",
    "EnableHttp2": "off",
    "XForwardedFor_ClientCertClientVerify": "off",
    "XForwardedFor_ClientCertFingerprint": "off"
}

错误码

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