| object | | |
HealthCheckHttpCode | string | The HTTP status code that indicates a successful health check. Separate multiple HTTP status codes with commas (,). Default value: http_2xx.
Valid values: http_2xx, http_3xx, http_4xx, and http_5xx.
Note
If you set the HealthCheck parameter to on, this parameter is required.
| http_3xx |
VServerGroupId | string | The ID of the vServer group that is associated with the forwarding rule. | rsp-cige6j**** |
Domain | string | The domain name that is configured in the forwarding rule. | test.com |
Cookie | string | The cookie to be configured on the backend server.
The cookie must be 1 to 200 characters in length and can contain ASCII letters and digits. It cannot contain commas (,), semicolons (;), or whitespace characters. It cannot start with a dollar sign ($).
If you set the StickySession parameter to on and the StickySessionType parameter to server, this parameter is required. | wwe |
LoadBalancerId | string | The ID of the SLB instance. | lb-bp1ca0zt07t934wxe**** |
ListenerPort | string | The listener port that is used by the SLB instance. | 90 |
HealthCheckInterval | integer | The time interval between two consecutive health checks.
Valid values: 1 to 50. Unit: seconds.
Note
If you set the HealthCheck parameter to on, this parameter is required.
| 34 |
Url | string | The URL that is configured in the forwarding rule. | /cache |
HealthCheckURI | string | The URI that is used for health checks.
Note
If you set the HealthCheck parameter to on, this parameter is required.
| 10.21.22.1 |
StickySessionType | string | The method that is used to handle a cookie. Valid values:
- insert: inserts a cookie into the response. SLB inserts a cookie (SERVERID) into the first HTTP or HTTPS response packet that is sent to a client. The next request from the client will contain this cookie, and the listener will distribute this request to the recorded backend server.
- server: rewrites a cookie. When SLB detects a user-defined cookie, SLB overwrites the original cookie with the user-defined cookie. The next request from the client contains the user-defined cookie, and the listener distributes the request to the recorded backend server.
Note
If you set the StickySession parameter to on, this parameter is required.
| insert |
RuleName | string | The name of the forwarding rule. | Rule1 |
RuleId | string | The ID of the forwarding rule. | rule-hfgnd***** |
HealthCheckConnectPort | integer | The port of the backend server that is used for health checks.
Valid values: 1 to 65535.
Note
If you set the HealthCheck parameter to on, this parameter is required. If you left this parameter empty and the HealthCheck parameter is set to on, the backend port configuration of the listener is used by default.
| 23 |
Scheduler | string | The scheduling algorithm. Valid values:
- wrr (default): Backend servers that have higher weights receive more requests than backend servers that have lower weights.
- rr: Requests are distributed to backend servers in sequence.
Note
If you set the ListenerSync parameter to off, this parameter is required. If you set the parameter to on, the configuration of the listener is used.
| wrr |
RequestId | string | | 9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C |
HealthCheckTimeout | integer | The timeout period of a health check response. If a backend ECS instance does not send an expected response within the specified period of time, the ECS instance is considered unhealthy.
Valid values: 1 to 300. Unit: seconds.
Note
If the value of the HealthCHeckTimeout parameter is smaller than that of the HealthCheckInterval parameter, the value of the HealthCHeckTimeout parameter is ignored and the value of the HealthCheckInterval parameter is regarded as the waiting period. If you set the HealthCheck parameter to on, this parameter is required.
| 34 |
ListenerSync | string | Indicates whether the forwarding rule uses the scheduling algorithm, session persistence, and health check configurations of the listener.
Valid values: on and off.
- off: does not use the configurations of the listener. You can customize health check and session persistence configurations for the forwarding rule.
- on: uses the configurations of the listener.
| off |
HealthyThreshold | integer | The number of consecutive successful health checks that must occur before an unhealthy backend server is declared healthy. In this case, the health check state is changed from fail to success.
Valid values: 2 to 10.
Note
If you set the HealthCheck parameter to on, this parameter is required.
| 2 |
CookieTimeout | integer | The timeout period of a cookie.
Valid values: 1 to 86400. Unit: seconds.
Note
If you set the StickySession parameter to on and the StickySessionType parameter to insert, this parameter is required.
| 12 |
HealthCheckDomain | string | The domain name that is used for health checks. Valid values:
- $_ip: The private IP address of the backend server. If the $_ip parameter is set or the HealthCheckDomain parameter is not set, SLB uses the private IP addresses of backend servers as the domain names for health checks.
- domain: The domain name must be 1 to 80 characters in length. It can contain only letters, digits, periods (.),and hyphens (-).
Note
If you set the HealthCheck parameter to on, this parameter is required.
| www.example.com |
UnhealthyThreshold | integer | The number of consecutive failed health checks that must occur before a healthy backend server is declared unhealthy. In this case, the health check state is changed from success to fail.
Valid values: 2 to 10.
Note
If you set the HealthCheck parameter to on, this parameter is required.
| 3 |
StickySession | string | Indicates whether session persistence is enabled.
Valid values: on and off.
Note
If you set the ListenerSync parameter to off, this parameter is required. If you set the parameter to on, the configuration of the listener is used.
| off |
HealthCheck | string | Specifies whether to enable health checks.
Valid values: on and off.
Note
If you set the ListenerSync parameter to off, this parameter is required. If you set the parameter to on, the configuration of the listener is used.
| off |