调用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。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 365F4154-92F6-4AE4-92F8-7FF34B540710 |
请求ID。 |
ListenerPort | Integer | 80 |
负载均衡实例前端使用的端口。 |
BackendServerPort | Integer | 80 |
负载均衡实例后端使用的端口。 |
Bandwidth | Integer | -1 |
监听的带宽峰值。 |
Status | String | stopped |
当前监听的状态。 取值:running|stopped。 |
SecurityStatus | String | on |
安全状态。 取值:on|off。 |
XForwardedFor | String | on |
是否开启通过X-Forwarded-For的方式获取来访者真实IP。 取值:on | off。 |
Scheduler | String | wrr |
调度算法。 取值:wrr | wlc | rr。
|
StickySession | String | on |
是否开启会话保持。 取值:on | off。 |
StickySessionType | String | insert |
cookie的处理方式。当StickySession的值为on时,必须指定该参数。 取值:insert | server。
说明 当StickySession的值为on时,必须指定该参数。
|
CookieTimeout | Integer | 500 |
cookie超时时间。 |
Cookie | String | B490B5EBF6F3CD402E515D22BCDA1598 |
服务器上配置的cookie。 |
HealthCheck | String | on |
是否开启健康检查。 取值:on | off。 |
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 |
健康检查的时间间隔,单位为秒。 |
HealthCheckConnectPort | Integer | 8080 |
健康检查的端口。 说明 当HealthCheck值为on时才会有效。
|
HealthCheckHttpCode | String | http_2xx,http_3xx |
健康检查正常的HTTP状态码。 |
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压缩。 取值:on | off。 |
XForwardedFor_SLBIP | String | on |
是否通过 取值:on | off。 |
XForwardedFor_SLBID | String | on |
是否通过 取值:on | off。 |
XForwardedFor_proto | String | on |
是否通过 取值:on | off。 |
AclId | String | 45 |
监听绑定的访问策略组ID。 当AclStatus参数的值为on时,该参数必选。 |
AclType | String | white |
访问控制类型:
当AclStatus参数的值为on时,该参数必选。 |
AclStatus | String | off |
是否开启访问控制功能。 取值:on | off(默认值)。 |
RequestTimeout | Integer | 43 |
指定请求超时时间,取值范围为1-180秒,默认值为60秒。 在超时时间内后端服务器一直没有响应,负载均衡将放弃等待,给客户端返回HTTP 504错误码。 |
IdleTimeout | Integer | 23 |
指定连接空闲超时时间,取值范围为1-60秒,默认值为15秒。 在超时时间内一直没有访问请求,负载均衡会暂时中断当前连接,直到一下次请求来临时重新建立新的连接。 |
EnableHttp2 | String | off |
是否开启HTTP/2特性。 取值:on(默认值)| off。 |
TLSCipherPolicy | String | tls_cipher_policy_1_0 |
只有性能保障型实例才可以指定TLSCipherPolicy参数,每种policy定义了一种安全策略,安全策略包含HTTPS可选的TLS协议版本和配套的加密算法套件。 目前支持以下四种安全策略,详细区别请参见TLS安全策略差异说明,请根据实际情况选择对应的policy。
|
Description | String | 监听描述 |
监听描述。 |
XForwardedFor_SLBPORT | String | off |
通过 取值:on | off。 |
XForwardedFor_ClientSrcPort | String | off |
通过 取值:on | off。 |
XForwardedFor_ClientCertSubjectDN | String | off |
通过 取值:on | off。 |
XForwardedFor_ClientCertIssuerDN | String | off |
通过 取值:on | off。 |
XForwardedFor_ClientCertFingerprint | String | off |
通过 取值:on | off。 |
XForwardedFor_ClientCertClientVerify | String | off |
通过XForwardedFor_ClientCertClientVerify头字段获取对访问负载均衡实例客户端证书的校验结果。 取值:on | off。 |
Rules | Array |
监听下的转发规则列表。 |
|
RuleId | String | 23 |
转发规则ID。 |
RuleName | String | example |
转发规则名称。 |
Domain | String | www.example.com |
域名。 |
Url | String | /example |
访问路径。 |
VServerGroupId | String | 12 |
转发规则的目标服务器组ID。 |
DomainExtensions | Array |
域名扩展列表。 |
|
DomainExtensionId | String | 12 |
域名扩展ID。 |
Domain | String | www.example.com |
域名。 |
ServerCertificateId | String | 133444444565 |
与域名对应的证书ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeLoadBalancerHTTPSListenerAttribute
&ListenerPort=80
&LoadBalancerId=lb-bp1mxu5r8lau*******
&<公共请求参数>
正常返回示例
XML
格式
<DescribeLoadBalancerHTTPSListenerAttributeResponse>
<RequestId>11F52428-64ED-40F7-98C2-DBB6D0BB0AD7</RequestId>
<HealthCheckHttpCode>http_2xx,http_3xx</HealthCheckHttpCode>
<HealthCheckTimeout>5</HealthCheckTimeout>
<ServerCertificateId>1231579xxxxxxxx_15dbf6ff26f_1991415478_2054196746</ServerCertificateId>
<XForwardedFor_SLBID>off</XForwardedFor_SLBID>
<Gzip>on</Gzip>
<HealthyThreshold>3</HealthyThreshold>
<Scheduler>wrr</Scheduler>
<StickySession>off</StickySession>
<UnhealthyThreshold>3</UnhealthyThreshold>
<XForwardedFor_SLBIP>off</XForwardedFor_SLBIP>
<XForwardedFor_proto>off</XForwardedFor_proto>
<Bandwidth>-1</Bandwidth>
<HealthCheckURI>/</HealthCheckURI>
<VServerGroupId>rsp-0xiju72x******</VServerGroupId>
<HealthCheck>on</HealthCheck>
<ListenerPort>443</ListenerPort>
<Status>running</Status>
<XForwardedFor>on</XForwardedFor>
<HealthCheckDomain></HealthCheckDomain>
<HealthCheckInterval>2</HealthCheckInterval>
<BackendServerPort>443</BackendServerPort>
</DescribeLoadBalancerHTTPSListenerAttributeResponse>
JSON
格式
{
"RequestId": "11F52428-64ED-40F7-98C2-DBB6D0BB0AD7",
"HealthCheckHttpCode": "http_2xx,http_3xx",
"HealthCheckTimeout": 5,
"ServerCertificateId": "1231579xxxxxxxx_15dbf6ff26f_1991415478_2054196746",
"XForwardedFor_SLBID": "off",
"Gzip": "on",
"HealthyThreshold": 3,
"Scheduler": "wrr",
"StickySession": "off",
"UnhealthyThreshold": 3,
"XForwardedFor_SLBIP": "off",
"XForwardedFor_proto": "off",
"Bandwidth": -1,
"HealthCheckURI": "/",
"VServerGroupId": "rsp-0xiju72x******",
"HealthCheck": "on",
"ListenerPort": 443,
"Status": "running",
"XForwardedFor": "on",
"HealthCheckDomain": "",
"HealthCheckInterval": 2,
"BackendServerPort": 443
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交