SetRule

The region ID of the SLB instance.

You can call the DescribeRegions operation to query the region ID.

The ID of the forwarding rule.

The ID of the target vServer group for the forwarding rule.

The name of the forwarding rule. The name must be 1 to 40 characters in length and can contain Chinese characters, letters, digits, hyphens (-), forward slashes (/), periods (.), and underscores (_).

Specifies whether to inherit the health check, session persistence, and scheduling algorithm configurations from the listener. Valid values:

• on: Inherits the configurations of the listener.

• off: Does not inherit the configurations of the listener. The forwarding rule uses custom health check and session persistence configurations.

The scheduling algorithm. Valid values:

• wrr: Backend servers with higher weights receive more requests.

• rr: Requests are distributed to backend servers in sequence.

Specifies whether to enable session persistence. Valid values:

• on: Enables session persistence.

• off: Disables session persistence.

This parameter is required and takes effect only when ListenerSync is set to off.

The method used to handle cookies. Valid values:

• insert: Insert cookie. When a client accesses the Server Load Balancer for the first time, the Server Load Balancer inserts a cookie into the response by adding the backend server ID to the HTTP or HTTPS response message. When the client sends a subsequent request with this cookie, the Server Load Balancer forwards the request to the backend server that was recorded during the first access.

• server: Rewrite cookie. When the Server Load Balancer detects a custom cookie, it rewrites the original cookie. When the client sends a subsequent request with the new cookie, the Server Load Balancer forwards the request to the previously recorded backend server.

The timeout period of the cookie. Unit: seconds. Valid values: 1 to 86400.

The cookie configured on the server.

The cookie must be 1 to 200 characters in length and can contain only ASCII letters and digits. It cannot contain commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($).

Specifies whether to enable the health check. Valid values:

• on: Enables the health check.

• off: Disables the health check.

The domain name used for health checks. Valid values:

• $_ip: The private IP of the backend server. If $_ip is specified or HealthCheckDomain is not specified, the Server Load Balancer uses the private IP of each backend server as the domain name for health checks.

• domain: A custom domain name. The domain name must be 1 to 80 characters in length and can contain only letters, digits, periods (.), and hyphens (-).

The URI used for health checks.

The number of consecutive successful health checks that must occur before the health check status of a backend server is changed from Failed to Successful.

Valid values: 2 to 10.

The number of consecutive failed health checks that must occur before the health check status of a backend server is changed from Successful to Failed.

Valid values: 2 to 10.

The timeout period for receiving a response from a health check. If the backend ECS instance does not respond correctly within the specified time, the health check is considered failed. Unit: seconds. Valid values: 1 to 300.

The interval between two consecutive health checks. Unit: seconds. Valid values: 1 to 50.

The port used for health checks. Valid values: 1 to 65535.

The HTTP status codes that indicate a successful health check. Separate multiple HTTP status codes with commas (,).

Valid values: http_2xx, http_3xx, http_4xx, and http_5xx.

Specifies whether to only precheck this request. Valid values:

• true: Sends a precheck request without performing the operation. If the precheck succeeds, the DryRunOperation error code is returned.

• false (default): Sends a normal request and performs the operation after the precheck succeeds.