调用DescribeLoadBalancerHTTPSListenerAttribute查询传统型负载均衡实例的HTTPS监听配置。
前提条件
- 您已经创建传统型负载均衡,具体操作,请参见CreateLoadBalancer。
- 您已经创建HTTPS监听,具体操作,请参见CreateLoadBalancerHTTPSListener。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
RegionId | String | 否 | cn-hangzhou |
传统型负载均衡实例的地域ID。 |
Action | String | 是 | DescribeLoadBalancerHTTPSListenerAttribute |
系统规定参数。取值:DescribeLoadBalancerHTTPSListenerAttribute。 |
LoadBalancerId | String | 是 | lb-bp1mxu5r8lau**** |
传统型负载均衡实例的ID。 |
ListenerPort | Integer | 是 | 80 |
实例前端使用的端口。 取值:1~65535。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
AclType | String | white |
访问控制类型:
说明 当AclStatus参数的值为on时,该参数必选。
|
XForwardedFor_ClientCertClientVerify | String | off |
是否通过
|
CACertificateId | String | idkp-234-cn-test-0** |
CA证书ID。 |
RequestId | String | 365F4154-92F6-4AE4-92F8-7FF3******** |
请求ID。 |
HealthCheckConnectPort | Integer | 8080 |
健康检查的端口。 说明 当HealthCheck值为on时才会有效。
|
BackendServerPort | Integer | 8080 |
实例后端使用的端口。 |
CookieTimeout | Integer | 500 |
Cookie超时时间。 |
HealthCheckDomain | String | www.test.com |
用于健康检查的域名。 |
XForwardedFor | String | on |
是否通过
|
XForwardedFor_ClientCertFingerprint | String | off |
是否通过
|
IdleTimeout | Integer | 23 |
指定连接空闲超时时间,取值范围为1~60,默认值为15。单位:秒。 在超时时间内一直没有访问请求,负载均衡会暂时中断当前连接,直到一下次请求来临时重新建立新的连接。 |
ListenerPort | Integer | 80 |
实例前端使用的端口。 |
HealthCheckURI | String | /test/index.html |
用于健康检查的URI。 |
XForwardedFor_SLBPORT | String | off |
是否通过
|
StickySessionType | String | insert |
Cookie的处理方式。 取值:insert或server。
|
Scheduler | String | wrr |
调度算法。取值:wrr或rr。
|
XForwardedFor_proto | String | on |
是否通过
|
HealthCheckMethod | String | get |
监听HTTP类型健康检查的健康检查方法。取值:head或get。 说明 HealthCheck值为on时,该参数才会显示。
|
TLSCipherPolicy | String | tls_cipher_policy_1_0 |
只有性能保障型实例才可以指定TLSCipherPolicy参数,每种policy定义了一种安全策略。 安全策略包含HTTPS可选的TLS协议版本和配套的加密算法套件。
|
Status | String | stopped |
当前监听的状态。取值:
|
VServerGroupId | String | rsp-cige6j5e******** |
绑定的服务器组ID。 |
XForwardedFor_ClientSrcPort | String | off |
是否通过
|
Cookie | String | B490B5EBF6F3CD402E515D22BCDA1598 |
服务器上配置的Cookie。 |
Gzip | String | on |
是否开启
|
EnableHttp2 | String | off |
是否开启
|
Bandwidth | Integer | -1 |
监听的带宽峰值。单位:Mbps。 |
Description | String | test |
监听描述。 |
HealthCheckTimeout | Integer | 3 |
每次健康检查响应的最大超时间。单位:秒。 |
AclStatus | String | off |
是否开启访问控制功能。取值:
|
UnhealthyThreshold | Integer | 4 |
不健康检查阈值。 |
XForwardedFor_SLBID | String | on |
是否通过
|
XForwardedFor_ClientCertSubjectDN | String | off |
是否通过
|
SecurityStatus | String | on |
是否处于安全状态。取值:
|
HealthCheckHttpCode | String | http_2xx,http_3xx |
健康检查正常的HTTP状态码。 |
RequestTimeout | Integer | 43 |
指定请求超时时间,取值范围为1~180,默认值为60。单位:秒。 在超时时间内后端服务器一直没有响应,负载均衡将放弃等待,给客户端返回HTTP 504错误码。 |
HealthCheckInterval | Integer | 5 |
健康检查的时间间隔。单位:秒。 |
ServerCertificateId | String | idkp-123-cn-test-0** |
服务器证书的ID。 |
AclId | String | nacl-a2do9e413e0spzasx**** |
监听绑定的访问策略组ID。 说明 当AclStatus参数的值为on时,该参数必选。
|
XForwardedFor_ClientCertIssuerDN | String | off |
是否通过
|
HealthyThreshold | Integer | 4 |
健康检查阈值。 |
XForwardedFor_SLBIP | String | on |
是否通过
|
StickySession | String | on |
是否开启会话保持。取值:
|
HealthCheck | String | on |
是否开启健康检查。取值:
|
Rules | Array of Rule |
监听下的转发规则列表。 |
|
Rule | |||
VServerGroupId | String | 12 |
转发规则的目标服务器组ID。 |
Url | String | /example |
访问路径。 |
Domain | String | www.example.com |
域名。 |
RuleName | String | example |
转发规则名称。 |
RuleId | String | 23 |
转发规则ID。 |
DomainExtensions | Array of DomainExtension |
域名扩展列表。 |
|
DomainExtension | |||
ServerCertificateId | String | 13344444**** |
与域名对应的证书ID。 |
Domain | String | www.example.com |
域名。 |
DomainExtensionId | String | 12 |
域名扩展ID。 |
LoadBalancerId | String | lb-bp1mxu5r8lau**** |
传统型负载均衡实例ID。 |
示例
请求示例
http(s)://[Endpoint]/?RegionId=cn-hangzhou
&Action=DescribeLoadBalancerHTTPSListenerAttribute
&LoadBalancerId=lb-bp1mxu5r8lau****
&ListenerPort=80
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeLoadBalancerHTTPSListenerAttributeResponse>
<AclType>white</AclType>
<XForwardedFor_ClientCertClientVerify>off</XForwardedFor_ClientCertClientVerify>
<CACertificateId>idkp-234-cn-test-0**</CACertificateId>
<RequestId>365F4154-92F6-4AE4-92F8-7FF3********</RequestId>
<HealthCheckConnectPort>8080</HealthCheckConnectPort>
<BackendServerPort>8080</BackendServerPort>
<CookieTimeout>500</CookieTimeout>
<HealthCheckDomain>www.test.com</HealthCheckDomain>
<XForwardedFor>on</XForwardedFor>
<XForwardedFor_ClientCertFingerprint>off</XForwardedFor_ClientCertFingerprint>
<IdleTimeout>23</IdleTimeout>
<ListenerPort>80</ListenerPort>
<HealthCheckURI>/test/index.html</HealthCheckURI>
<XForwardedFor_SLBPORT>off</XForwardedFor_SLBPORT>
<StickySessionType>insert</StickySessionType>
<Scheduler>wrr</Scheduler>
<XForwardedFor_proto>on</XForwardedFor_proto>
<HealthCheckMethod>get</HealthCheckMethod>
<TLSCipherPolicy>tls_cipher_policy_1_0</TLSCipherPolicy>
<Status>stopped</Status>
<VServerGroupId>rsp-cige6j5e********</VServerGroupId>
<XForwardedFor_ClientSrcPort>off</XForwardedFor_ClientSrcPort>
<Cookie>B490B5EBF6F3CD402E515D22BCDA1598</Cookie>
<Gzip>on</Gzip>
<EnableHttp2>off</EnableHttp2>
<Bandwidth>-1</Bandwidth>
<Description>test</Description>
<HealthCheckTimeout>3</HealthCheckTimeout>
<AclStatus>off</AclStatus>
<UnhealthyThreshold>4</UnhealthyThreshold>
<XForwardedFor_SLBID>on</XForwardedFor_SLBID>
<XForwardedFor_ClientCertSubjectDN>off</XForwardedFor_ClientCertSubjectDN>
<SecurityStatus>on</SecurityStatus>
<HealthCheckHttpCode>http_2xx,http_3xx</HealthCheckHttpCode>
<RequestTimeout>43</RequestTimeout>
<HealthCheckInterval>5</HealthCheckInterval>
<ServerCertificateId>idkp-123-cn-test-0**</ServerCertificateId>
<AclId>nacl-a2do9e413e0spzasx****</AclId>
<XForwardedFor_ClientCertIssuerDN>off</XForwardedFor_ClientCertIssuerDN>
<HealthyThreshold>4</HealthyThreshold>
<XForwardedFor_SLBIP>on</XForwardedFor_SLBIP>
<StickySession>on</StickySession>
<HealthCheck>on</HealthCheck>
<Rules>
<VServerGroupId>12</VServerGroupId>
<Url>/example</Url>
<Domain>www.example.com</Domain>
<RuleName>example</RuleName>
<RuleId>23</RuleId>
</Rules>
<DomainExtensions>
<ServerCertificateId>13344444****</ServerCertificateId>
<Domain>www.example.com</Domain>
<DomainExtensionId>12</DomainExtensionId>
<Certificates/>
<ServerCertificates/>
</DomainExtensions>
<ServerCertificates/>
<LoadBalancerId>lb-bp1mxu5r8lau****</LoadBalancerId>
</DescribeLoadBalancerHTTPSListenerAttributeResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/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" : "B490B5EBF6F3CD402E515D22BCDA1598",
"Gzip" : "on",
"EnableHttp2" : "off",
"Bandwidth" : -1,
"Description" : "test",
"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" : "nacl-a2do9e413e0spzasx****",
"XForwardedFor_ClientCertIssuerDN" : "off",
"HealthyThreshold" : 4,
"XForwardedFor_SLBIP" : "on",
"StickySession" : "on",
"HealthCheck" : "on",
"AclIds" : [ ],
"Rules" : [ {
"VServerGroupId" : "12",
"Url" : "/example",
"Domain" : "www.example.com",
"RuleName" : "example",
"RuleId" : "23"
} ],
"DomainExtensions" : [ {
"ServerCertificateId" : "13344444****",
"Domain" : "www.example.com",
"DomainExtensionId" : "12",
"Certificates" : [ { } ],
"ServerCertificates" : [ { } ]
} ],
"ServerCertificates" : [ { } ],
"LoadBalancerId" : "lb-bp1mxu5r8lau****"
}
错误码
访问错误中心查看更多错误码。