DescribeLoadBalancerHTTPSListenerAttribute - 查询HTTPS监听配置 - 负载均衡

查询HTTPS监听配置。

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

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

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	传统型负载均衡实例的地域 ID。	cn-hangzhou
LoadBalancerId	string	是	传统型负载均衡实例的 ID。	lb-bp1mxu5r8lau****
ListenerPort	integer	是	实例前端使用的端口。取值：1~65535。	80

返回参数

名称	类型	描述	示例值
	object
AclType	string	访问控制类型： white：仅转发来自所选访问控制策略组中设置的 IP 地址或地址段的请求，白名单适用于只允许特定 IP 访问的场景。设置白名单存在一定业务风险。一旦设置白名单，就只有白名单中的 IP 可以访问负载均衡监听。如果开启了白名单访问，但访问策略组中没有添加任何 IP，则负载均衡监听会转发全部请求。 black：来自所选访问控制策略组中设置的 IP 地址或地址段的所有请求都不会转发，黑名单适用于只限制某些特定 IP 访问的场景。如果开启了黑名单访问，但访问策略组中没有添加任何 IP，则负载均衡监听会转发全部请求。说明当 AclStatus 参数的值为 on 时，该参数必选。	white
XForwardedFor_ClientCertClientVerify	string	是否通过`XForwardedFor_ClientCertClientVerify`头字段获取对访问负载均衡实例客户端证书的校验结果。取值： on：是。 off：否。	off
CACertificateId	string	CA 证书 ID。	idkp-234-cn-test-0**
RequestId	string	请求 ID。	365F4154-92F6-4AE4-92F8-7FF3********
HealthCheckConnectPort	integer	健康检查的端口。说明当 HealthCheck 值为 on 时才会有效。	8080
BackendServerPort	integer	实例后端使用的端口。	8080
CookieTimeout	integer	Cookie 超时时间。	500
HealthCheckDomain	string	用于健康检查的域名。	www.test.com
XForwardedFor	string	是否通过`X-Forwarded-For`的方式获取来访者真实 IP。取值： on：是。 off：否。	on
XForwardedFor_ClientCertFingerprint	string	是否通过`XForwardedFor_ClientCertFingerprint`头字段获取访问负载均衡实例客户端证书的指纹。取值： on：是。 off：否。	off
IdleTimeout	integer	指定连接空闲超时时间，取值范围为 1~60，默认值为 15。单位：秒。在超时时间内一直没有访问请求，负载均衡会暂时中断当前连接，直到一下次请求来临时重新建立新的连接。	23
ListenerPort	integer	实例前端使用的端口。	80
HealthCheckURI	string	用于健康检查的 URI。	/test/index.html
XForwardedFor_SLBPORT	string	是否通过`XForwardedFor_SLBPORT`头字段获取负载均衡实例的监听端口。取值： on：是。 off：否。	off
StickySessionType	string	Cookie 的处理方式。取值：insert 或 server。 insert：植入 Cookie。客户端第一次访问时，负载均衡会在返回请求中植入 Cookie，下次客户端携带此 Cookie 访问，负载均衡服务会将请求定向转发给之前记录到的后端服务器上。 server：重写 Cookie。负载均衡发现用户自定义了 Cookie，将会对原来的 Cookie 进行重写，下次客户端携带新的 Cookie 访问，负载均衡服务会将请求定向转发给之前记录到的后端服务器。	insert
Scheduler	string	调度算法。取值：wrr 或 rr。 wrr：权重值越高的后端服务器，被轮询到的概率也越高。 rr：按照访问顺序依次将外部请求依序分发到后端服务器。	wrr
XForwardedFor_proto	string	是否通过`X-Forwarded-Proto`头字段获取负载均衡实例的监听协议。取值： on：是。 off：否。	on
HealthCheckMethod	string	监听 HTTP 类型健康检查的健康检查方法。取值：head 或 get。说明 HealthCheck 值为 on 时，该参数才会显示。	get
TLSCipherPolicy	string	只有性能保障型实例才可以指定 TLSCipherPolicy 参数，每种 policy 定义了一种安全策略。安全策略包含 HTTPS 可选的 TLS 协议版本和配套的加密算法套件。 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。 tls_cipher_policy_1_2_strict_with_1_3 支持 TLS 版本：TLSv1.2 及 TLSv1.3。支持的加密算法套件：TLS_AES_128_GCM_SHA256、TLS_AES_256_GCM_SHA384、TLS_CHACHA20_POLY1305_SHA256、TLS_AES_128_CCM_SHA256、TLS_AES_128_CCM_8_SHA256、ECDHE-ECDSA-AES128-GCM-SHA256、ECDHE-ECDSA-AES256-GCM-SHA384、ECDHE-ECDSA-AES128-SHA256、ECDHE-ECDSA-AES256-SHA384、ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-ECDSA-AES128-SHA、ECDHE-ECDSA-AES256-SHA、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA。	tls_cipher_policy_1_0
Status	string	当前监听的状态。取值： running：运行中。 stopped：已停止。	stopped
VServerGroupId	string	绑定的服务器组 ID。	rsp-cige6j5e********
XForwardedFor_ClientSrcPort	string	是否通过`XForwardedFor_ClientSrcPort`头字段获取访问负载均衡实例客户端的端口。取值： on：是。 off：否。	off
Cookie	string	服务器上配置的 Cookie。	testCookie
Gzip	string	是否开启`Gzip`压缩。取值： on：是。 off：否。	on
EnableHttp2	string	是否开启`HTTP2`特性。取值： on：是。 off：否。	off
Bandwidth	integer	监听的带宽峰值。单位：Mbps。	10
Description	string	自定义监听名称。	HTTPS_443
HealthCheckTimeout	integer	每次健康检查响应的最大超时间。单位：秒。	3
AclStatus	string	是否开启访问控制功能。取值： on：是。 off：否。	off
UnhealthyThreshold	integer	不健康检查阈值。	4
XForwardedFor_SLBID	string	是否通过`SLB-ID`头字段获取负载均衡实例 ID。取值： on：是。 off：否。	on
XForwardedFor_ClientCertSubjectDN	string	是否通过`XForwardedFor_ClientCertSubjectDN`头字段获取访问负载均衡实例客户端证书的所有者信息。取值： on：是。 off：否。	off
SecurityStatus	string	是否处于安全状态。取值： on：是。 off：否。	on
HealthCheckHttpCode	string	健康检查正常的 HTTP 状态码。	http_2xx,http_3xx
RequestTimeout	integer	指定请求超时时间，取值范围为 1~180，默认值为 60。单位：秒。在超时时间内后端服务器一直没有响应，负载均衡将放弃等待，给客户端返回 HTTP 504 错误码。	43
HealthCheckInterval	integer	健康检查的时间间隔。单位：秒。	5
ServerCertificateId	string	服务器证书的 ID。	idkp-123-cn-test-0**
AclId	string	监听绑定的访问策略组 ID。说明当 AclStatus 参数的值为 on 时，该参数必选。	acl-a2do9e413e0spzasx****
XForwardedFor_ClientCertIssuerDN	string	是否通过`XForwardedFor_ClientCertIssuerDN`头字段获取访问负载均衡实例客户端证书的发行者信息。取值： on：是。 off：否。	off
HealthyThreshold	integer	健康检查阈值。	4
XForwardedFor_SLBIP	string	是否通过`SLB-IP`头字段获取客户端请求的 VIP（Virtual IP address）。取值： on：是。 off：否。	on
StickySession	string	是否开启会话保持。取值： on：开启。 off：未开启。	on
HealthCheck	string	是否开启健康检查。取值： on：是。 off：否。	on
AclIds	array	监听绑定的访问策略组 ID。
Rules	array<object>	监听下的转发规则列表。
	object	监听下的转发规则列表。
VServerGroupId	string	转发规则的目标服务器组 ID。	rsp-cige6j5e********
Url	string	访问路径。	/example
Domain	string	域名。	www.example.com
RuleName	string	转发规则名称。	example
RuleId	string	转发规则 ID。	23
DomainExtensions	array<object>	域名扩展列表。
	object	域名扩展列表。
ServerCertificateId	string	与域名对应的证书 ID。	13344444****
Domain	string	域名。	www.example.com
DomainExtensionId	string	域名扩展 ID。	12
LoadBalancerId	string	传统型负载均衡实例 ID。	lb-bp1mxu5r8lau****
Tags	array<object>	标签列表。
	object	标签列表。
TagKey	string	监听的标签键。N 的取值范围：1~20。一旦传入该值，则不允许为空字符串。最多支持 64 个字符，不能以`aliyun`或`acs:`开头，不能包含`http://`或`https://`。	TestKey
TagValue	string	监听的标签值。N 的取值范围：1~20。一旦传入该值，可以为空字符串。最多支持 128 个字符，不能以`acs:`开头，不能包含`http://`或者`https://`。	TestValue

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-05-28	OpenAPI 返回结构发生变更	查看变更详情