DescribeLoadBalancerHTTPSListenerAttribute

Description

Call DescribeLoadBalancerHTTPSListenerAttribute to query HTTPS listening configuration.

Request Method

POST

Request Path

/apsara/route/Slb/DescribeLoadBalancerHTTPSListenerAttribute

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
ListenerPort	BODY	integer	Yes	80	the port used by the front end of the load balancing instance. value:1~65535.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
LoadBalancerId	BODY	string	Yes	lb-bp1mxu5r8lau****	load balancing instance ID.
version	BODY	string	No	2016-01-01	version of api

Return data

Name	Type	Sample value	Description
CookieTimeout	integer	500	Cookie timeout.
MaxConnection	integer	10	No description for this parameter.
VServerGroupId	string	rsp-cige6j5e****	bound server group ID.
Description	string	listening description	listening description information. The length is 2~256 characters and must be characters in Chinese and the following strings:/([\x00-\xff]|[\w.,;/@-]){2,256}$/.
UnhealthyThreshold	integer	4	unhealthy check threshold.
Scheduler	string	wrr	scheduling algorithm. Value:wrr, wlc or rr. wrr(Default value): The backend server with the higher the weight value, the higher the number of times (probability) it is polled. wlc: In addition to polling according to the weight value set by each back-end server, the actual load of the back-end server (that is, the number of connections) is also considered. When the weight value is the same, the number of times (probability) that the backend server with the smaller the current number of connections is polled is higher. rr: distribute external requests to backend servers in sequence according to the access order.
HealthCheckURI	string	/test/index.html	URI for health check. The length is limited to 1 to 80. Only letters, numbers and dashes (-), forward slashes (/), English periods (.), percent signs (%), question marks (?), pound signs (#), and(& amp;) can be used. The URL cannot only be a forward slash (/), but must start with a forward slash (/).
HealthCheck	string	on	whether to turn on health check. Value:on or off.
IdleTimeout	integer	23	specifies the connection idle timeout period, the value range is 1~60 seconds, and the default value is 15 seconds. there has been no access request during the timeout period. load balancing will temporarily interrupt the current connection until the next request comes to temporarily re-establish a new connection.
BackendServerPort	integer	80	the port used by the backend of the load balancing instance.
XForwardedFor_SLBID	string	on	whether to pass SLB-ID header field to obtain the load balancing instance ID. value:on or off.
HealthCheckConnectPort	integer	8080	health check port. description when HealthCheck value is on is valid.
Bandwidth	integer	-1	peak bandwidth of listening.
SecurityStatus	string	on	security status. Value:on or off.
Gzip	string	on	whether to turn on Gzip compression. Value:on or off.
ServerCertificateId	string	idkp-123-cn-test-****	server certificate ID.
StickySessionType	string	insert	Cookie processing method. This parameter must be specified when the StickySession value is on. value:insert or server. insert: insert cookies. /span>/p> p data-tag = "p" class = "p"> when the client accesses for the first time, load balancing will implant Cookie in the return request (I .e. insert ServerId in HTTP or HTTPS response message). next time the client carries this Cookie for access, load balancing service will direct and forward the request to the backend server previously recorded. server: rewrite Cookie. /span>/p> p data-tag = "p" class = "p"> load balancing finds that the user has customized the cookie, and will rewrite the original cookie. next time the client carries a new cookie to access, the load balancing service will directionally forward the request to the back-end server previously recorded. description when StickySession the value is on, this parameter must be specified.
XForwardedFor_SLBIP	string	on	whether to pass SLB-IP header field obtains the real IP of the client request. value:on or off.
HealthCheckHttpCode	string	http_2xx	HTTP status code for normal health check. Multiple status codes are separated by commas. Value:http_2xx(default), http_3xx, http_4xx or http_5xx.
Status	string	stopped	the current status of listening. Value:running or stopped.
Cookie	string	B490B5EBF6F3CD402E515D22BCDA1598	Cookie configured on the server.
ListenerPort	integer	80	the port used by the front end of the load balancing instance.
RequestTimeout	integer	43	specifies the request timeout period, which ranges from 1 to 180 seconds, and the default value is 60 seconds. /p> p data-tag = "p" class = "p"> the back-end server has not responded during the timeout period. load balancing will give up waiting and return the HTTP 504 error code to the client.
HealthCheckInterval	integer	5	the interval of health check, in seconds. value:1~50 seconds.
TLSCipherPolicy	string	tls_cipher_policy_1_0	Only performance guaranteed instances can specify TLSCipherPolicy parameters. Each policy defines 1 security policy. The security policy includes HTTPS optional TLS protocol version and supporting encryption algorithm suite. currently supports the following 4 security policies. please refer to the TLS security policy differences for detailed differences. Please select the corresponding policy according to the actual situation. tls_cipher_policy_1_0: Support TLS version: TLSv1.0, TLSv1.1 and TLSv1.2. supports encryption algorithm suites: 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 and DES-CBC3-SHA. tls_cipher_policy_1_1: Support TLS version: TLSv1.1 and TLSv1.2. supports encryption algorithm suites: 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 and DES-CBC3-SHA. tls_cipher_policy_1_2 Support TLS version: TLSv1.2. supports encryption algorithm suites: 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 and DES-CBC3-SHA. tls_cipher_policy_1_2_strict Support TLS version: TLSv1.2. supports encryption algorithm suites: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, ECDHE-RSA-AES128-SHA and ECDHE-RSA-AES256-SHA.
RequestId	string	365F4154-92F6-4AE4-92F8-7FF34B540710	request ID.
CACertificateId	string	idkp-234-cn-test-****	CA certificate ID.
HealthCheckTimeout	integer	3	The maximum excess time of each health check response, in seconds.
StickySession	string	on	whether to enable session persistence. Value:on or off.
HealthyThreshold	integer	4	health check threshold.
XForwardedFor	string	on	whether to turn on the real IP of the customer through X-Forwarded-For. Value:on or off.
HealthCheckDomain	string	www.test.com	domain name used for health check.
XForwardedFor_proto	string	on	whether to pass X-Forwarded-Proto the header field obtains the listening protocol of the load balancing instance. value:on or off.

Example

Successful Response example

{
 "CookieTimeout":"500",
 "MaxConnection":"10",
 "VServerGroupId":"rsp-cige6j5e****",
 "Description":"listening description",
 "UnhealthyThreshold":"4",
 "Scheduler":"wrr",
 "HealthCheckURI":"/test/index.html",
 "HealthCheck":"on",
 "IdleTimeout":"23",
 "BackendServerPort":"80",
 "XForwardedFor_SLBID":"on",
 "HealthCheckConnectPort":"8080",
 "Bandwidth":"-1",
 "SecurityStatus":"on",
 "Gzip":"on",
 "ServerCertificateId":"idkp-123-cn-test-****",
 "StickySessionType":"insert",
 "XForwardedFor_SLBIP":"on",
 "HealthCheckHttpCode":"http_2xx",
 "Status":"stopped",
 "Cookie":"B490B5EBF6F3CD402E515D22BCDA1598",
 "ListenerPort":"80",
 "RequestTimeout":"43",
 "HealthCheckInterval":"5",
 "TLSCipherPolicy":"tls_cipher_policy_1_0",
 "RequestId":"365F4154-92F6-4AE4-92F8-7FF34B540710",
 "CACertificateId":"idkp-234-cn-test-****",
 "HealthCheckTimeout":"3",
 "StickySession":"on",
 "HealthyThreshold":"4",
 "XForwardedFor":"on",
 "HealthCheckDomain":"www.test.com",
 "XForwardedFor_proto":"on"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}