SetLoadBalancerHTTPSListenerAttribute

Description

call SetLoadBalancerHTTPSListenerAttribute to modify the configuration of HTTPS listening.

Request Method

POST

Request Path

/apsara/route/Slb/SetLoadBalancerHTTPSListenerAttribute

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
CookieTimeout	BODY	integer	No	500	Cookie timeout. value:1~86400 seconds. description when StickySession is on and StickySessionType is insert, this parameter is required.
VServerGroupId	BODY	string	No	rsp-cige6j****	virtual server group ID.
Description	BODY	string	No	listening description	listening description. The length is 2~256 characters and must be characters in Chinese and the following strings: ([\x00-\xff]|[\w.,;/@-]){2,256 }$.
UnhealthyThreshold	BODY	integer	No	4	after how many consecutive health checks have failed, determine the health check status of the back-end server from success to failure . value:2~10. description in HealthCheck value is on is valid.
Scheduler	BODY	string	No	wrr	scheduling algorithm. Value: 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	BODY	string	No	/test/index.html	URI for health check. The length is limited to 1 to 80, and only letters, numbers, dashes (-), forward slashes (/), half-width periods (.), percent signs (%), half-width question marks (?), pound signs (#), and & amp; characters can be used. The URL cannot only be a forward slash (/), but must start with a forward slash (/). description in HealthCheck value is on is valid.
HealthCheck	BODY	string	No	on	whether to turn on health check. Value:on or off.
IdleTimeout	BODY	integer	No	23	specify the connection idle timeout time, the value range is 1~60 seconds, the default value is 15 seconds. /span>/p> p data-tag = "p" class = "p"> 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.
LoadBalancerId	BODY	string	Yes	lb-sjhfdji****	ID of the load balancing instance.
VServerGroup	BODY	string	No	on	whether to use server groups. Value:on or off.
XForwardedFor_SLBID	BODY	string	No	on	whether to pass SLB-ID header field to obtain the load balancing instance ID. value:on or off.
HealthCheckConnectPort	BODY	integer	No	8080	port used for health check. value:1~65535. description when HealthCheck value is on is valid.
Bandwidth	BODY	integer	No	-1	peak bandwidth of listening. Value:-1 or 1~5120. -1: no bandwidth peak value is limited. 1~5120: the peak bandwidth of the listener. the sum of the peak bandwidth of all listeners cannot exceed the peak bandwidth of the instance.
Gzip	BODY	string	No	on	Whether to turn on Gzip compression to compress specific file types. Value:on or off.
ServerCertificateId	BODY	string	No	idkp-123-cn-te****	ID of the server certificate.
StickySessionType	BODY	string	No	insert	Cookie processing method. Value: 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	BODY	string	No	on	whether to pass SLB-IP header field obtains the real IP of the client request. value:on or off.
HealthCheckHttpCode	BODY	string	No	http_2xx,http_3xx	health check normal HTTP status code, multiple status codes are divided by half-width commas (,). Value:http_2xx, http_3xx, http_4xx or http_5xx. description in HealthCheck value is on is valid.
Tags	BODY	string	No	loadbalancerhttps****	tag.
Cookie	BODY	string	No	B490B5EBF6F3CD402E515D22BCDA1598	Cookie configured on the server. is 1 to 200 characters in length and can only contain ASCII English letters and numeric characters, cannot contain commas (,), semicolons (;) or spaces, and cannot start with dollar signs ($). description when StickySession is on and StickySessionType is server, this parameter is required.
ListenerPort	BODY	integer	Yes	80	the port used by the front end of the load balancing instance. value:1~65535.
RequestTimeout	BODY	integer	No	223	specify the request timeout time, the value range is 1~180 seconds, the default value is 60 seconds. /span>/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	BODY	integer	No	5	time interval for health check. value:1~50 seconds. description in HealthCheck value is on is valid.
TLSCipherPolicy	BODY	string	No	tls_cipher_policy_1_2	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 select the corresponding policy according to the actual situation. < B data-tag=" B "class=" B ">tls_cipher_policy_1_0: Supports TLS versions: 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. < B data-tag=" B "class=" B ">tls_cipher_policy_1_1: Supports TLS versions: 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. < B data-tag=" B "class=" B ">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. < B data-tag=" B "class=" B ">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.
CACertificateId	BODY	string	No	139a00604ad-cn-east-****	CA certificate ID. If both the CA certificate and the server certificate are uploaded, two-way authentication is adopted. If the user only uploads the server certificate, it is a one-way authentication.
HealthCheckTimeout	BODY	integer	No	3	the time to wait to receive the response from the health check. If the backend ECS does not respond correctly within the specified time, the health check is determined to have failed. value:1~300 seconds. description if HealthCHeckTimeout has a value less than HealthCheckInterval, then HealthCHeckTimeout is invalid, the timeout period is HealthCheckInterval. in HealthCheck value is on is valid.
version	BODY	string	No	2016-01-01	version of api
StickySession	BODY	string	No	on	whether to enable session persistence. Value:on or off.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
HealthyThreshold	BODY	integer	No	4	after how many consecutive successful health checks, determine the health check status of the back-end server from failure to success . value:2~10. description in HealthCheck value is on is valid.
XForwardedFor	BODY	string	No	on	whether to turn on obtaining the real IP of the customer through the X-Forwarded-For header field. Value:on or off.
HealthCheckDomain	BODY	string	No	172.XX.XX.6	domain name used for health check, value: $_ ip: the private network IP of the backend server. When the IP address is specified or this parameter is not specified, Server Load Balancer uses the private IP address of each backend server as the domain name used for health check. domain: The domain name is 1 to 80 characters in length and can only contain letters, numbers, half-width periods (.) and dashes (-). description in HealthCheck value is on is valid.
XForwardedFor_proto	BODY	string	No	on	whether to pass X-Forwarded-Proto the header field obtains the listening protocol of the load balancing instance. value:on or off.

Return data

Name	Type	Sample value	Description
RequestId	string	CEF72CEB-54B6-4AE8-B225-F876FF7BA984	request ID.

Example

Successful Response example

{
 "RequestId":"CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}

Failed Response example

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

}