SetRule

The operation that you want to perform.

Set the value to SetRule.

The ID of the region where the Classic Load Balancer (CLB) instance is created.

You can call theDescribeRegions operation to query region IDs.

The ID of the forwarding rule.

The ID of the vServer group with which the forwarding rule is associated.

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

Specifies 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.

This parameter is required and takes effect only when you specify off for ListenerSync.

The scheduling algorithm. Valid values:

• wrr (default): Backend servers that have higher weights receive more requests than those that have lower weights.
• rr: Requests are distributed to backend servers in sequence.

This parameter is required and takes effect only when you specify off for ListenerSync.

Specifies whether to enable session persistence. Valid values: on and off.

• on: enables session persistence.
• off: disables session persistence.

Specifies whether to insert or rewrite a cookie. This parameter is required and takes effect when you specify onforStickySession.

Valid values:

• insert: inserts a cookie.

  CLB inserts a cookie (SERVERID) into the first HTTP or HTTPS response that is sent to a client. The next request from the client will contain this cookie, and the listener will forward this request to the recorded backend server.

• server: rewrites a cookie.

  When CLB detects a user-defined cookie, it overwrites the original cookie with the user-defined cookie. The next request from the client will contain the user-defined cookie, and the listener will forward the request to the recorded backend server.

The timeout period of a cookie.

Valid values: 1 to 86400. Unit: seconds.

The cookie to be configured on the backend server.

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

Specifies whether to enable health checks.

Valid values: on and off.

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 specified or the HealthCheckDomain parameter is not specified, the CLB instance uses the private IP address of the backend server as the domain name for health checks.
• domain: The domain name must be 1 to 80 characters in length. It can contain only letters, digits, periods (.), and hyphens (-).

The URL that is used for health checks. This parameter is required and takes effect only when you set HealthCheck to on.

Specifies the number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy (from fail to success).

Valid values: 2 to 10.

Specifies the number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy (from success to fail).

Valid values: 2 to 10.

The timeout period of a health check response. If a backend Elastic Compute Service (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.

The interval between two consecutive health checks.

Valid values: 1 to 50. Unit: seconds.

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

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

The port that is used for health checks.

Valid values: 1 to 65535.

The ID of the request.