SetLoadBalancerHTTPSListenerAttribute - Developer Guide| Alibaba Cloud Documentation Center

Description

Configures an HTTPS Listener, including Scheduler, SticySession, HealthCheck, ServerCertificateId, etc.

Request Parameters

Name	Type	Required?	Description
Action	String	Yes	Operator interface name, required parameter. Value:SetLoadBalancerHTTPSListenerAttribute
LoadBalancerId	String	Yes	Unique ID of an Server Load Balancer instance.
ListenerPort	Integer	Yes	Server Load Balancer instance’s frontend port. Value:1-65535
Bandwidth	Integer	Yes	Listener’s peak bandwidth. Value: -1/1-1000Mbps For public instances using the PayByTraffic billing method, users can set the listener bandwidth to -1. This indicates the peak bandwidth is not restricted.
XForwardedFor	String	No	Whether or not the X-Forwarded-For method is enabled to retrieve visitors’ real IPs. Value: On/Off Default value: None When users do not specify this parameter, this indicates that this call does not modify this configuration option and the previous configuration is maintained. Note: For security considerations, this parameter is required to be set to On since May 15, 2015. For interface compatibility considerations, this interface incoming parameter is maintained.
Scheduler	String	No	Scheduling algorithm. Value: wrrwlc Default value:None When users do not specify this parameter, this indicates that this call does not modify this configuration option and the previous configuration is maintained.
StickySession	String	Yes	Whether or not session persistence is enabled. Value: on/off
StickySessionType	String	Depends on the situation	Cookie processing method. This parameter is required when StickySession is set to On. When StickySession is Off, the setting of this parameter is ignored. Value: insert server. When set to insert, this indicates it is inserted by the Server Load Balancer. When set to server, this indicates the Server Load Balancer learns from the backend server.
CookieTimeout	Integer	Depends on the situation	Cookie timeout time. This parameter is required when StickySession is On and StickySessionType is Insert. In other situations, this parameter is ignored. Value: 1-86400 (unit: seconds)
Cookie	String	Depends on the situation	Server’s cookie configuration. This parameter is only required when StickySession is On and StickySessionType is Insert. In other situations, this parameter is ignored. Value: A 1-200 character string following RFC 2965 format. It can only contain ASCII English letters and numbers, and cannot contain commas, semicolons, or spaces, nor can it begin with a “$” character.
HealthCheck	String	Yes	Whether or not health checks are enabled. Value: on/off
HealthCheckDomain	String	No	Health check domain name. Value: $_ip custom string null Custom string rules: 1-80 characters. Only letters, numbers, ‘-‘, and ‘.’ are allowed. When users set this parameter as ‘$_ip’ or null, Server Load Balancer will use the private IPs for each backend server as the domain for performing health checks.
HealthCheckURI	String	Depends on the situation	Health check URI. When HealthCheck is On, this parameter is required. When HealthCheck is Off, this parameter is ignored. Value: Length: 1-80, must start with ‘/‘. Only letters, numbers, ‘-‘, ‘/‘, ‘.‘, ‘%’, ‘?’, ‘#‘, and ‘&’ are allowed.
HealthCheckConnectPort	Integer	Depends on the situation	Port used for health checks. When HealthCheck is On, this parameter is required. When HealthCheck is Off, this parameter is ignored. Value: 1-65535 When users do not set this parameter, this indicates BackendServerPort is used.
HealthyThreshold	Integer	Depends on the situation	Threshold value for determining health check results as Success. That is, after this number of successful health checks, the backend server’s health check results will change from Fail to Success. When HealthCheck is On, this parameter is required. When HealthCheck is Off, this parameter is ignored. Value:1-10
UnhealthyThreshold	Integer	Depends on the situation	Threshold value for determining health check results as Fail. That is, after this number of failed health checks, the backend server’s health check results will change from Success to Fail. When HealthCheck is On, this parameter is required. When HealthCheck is Off, this parameter is ignored. Value:1-10
HealthCheckTimeout	Integer	Depends on the situation	Maximum timeout time for each health check response. When HealthCheck is On, this parameter is required. When HealthCheck is Off, this parameter is ignored. Value: 1-50 (unit: seconds) Note: If HealthCheckTimeout < HealthCheckInterval, HCTimeout is invalid, and the timeout time is the HealthCheckInterval.
HealthCheckInterval	Integer	Depends on the situation	Interval between health checks. When HealthCheck is On, this parameter is required. When HealthCheck is Off, this parameter is ignored. Value: 1-5 (unit: seconds)
HealthCheckHttpCode	String	Depends on the situation	Normal health check HTTP status codes. Separate multiple status codes with “,”. When HealthCheck is On, this parameter is optional. When HealthCheck is Off, this parameter is ignored. Value: http_2xx ， http_3xx ， http_4xx ， http_5xx Default value:http_2xx
ServerCertificateId	String	Yes	Security certificate ID.

Return Parameters

All are public return parameters. See Public Parameters.

Example

Request Example

https://slb.aliyuncs.com/
&Action=SetLoadBalancerHTTPSListenerAttribute
&LoadBalancerId=139a00604ad-cn-east-hangzhou-01
&ListenerPort=-520
&Bandwidth=-1
&ServerCertificateId=idkp-123-cn-test-01
&<Public Request Parameters>

Return Example

XML format

  <?xml version="1.0" encoding="UTF-8"?>
  <SetLoadBalancerHTTPSListenerAttributeResponse>
      <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
  </SetLoadBalancerHTTPSListenerAttributeResponse>

JSON format

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