Update Server Group Attributes with UpdateServerGroupAttribute - Gateway Load Balancer - Alibaba Cloud - Server Load Balancer

Updates the properties of a load balancing server group.

Operation description

The UpdateServerGroupAttribute operation is asynchronous. The system returns a request ID, but the server group configuration is not immediately updated. The update task continues to run in the background. You can call ListServerGroups to query the update status of the server group configuration:

When the server group configuration is in the Configuring state, the configuration is being updated.
When the server group configuration is in the Available state, the configuration is updated.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

gwlb:UpdateServerGroupAttribute

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ServerGroupId	string	Yes	The ID of the server group.	sgp-atstuj3rtoptyui****
ServerGroupName	string	No	The name of the server group. The name must be 2 to 128 characters in length, and must start with a letter or Chinese character. It can contain digits, periods (.), underscores (_), and hyphens (-).	testServerGroupName
Scheduler	string	No	The scheduling algorithm. Valid values: 5TCH: 5-tuple hash. Consistent hashing based on the 5-tuple (source IP address, destination IP address, source port, destination port, and protocol). Requests from the same flow are scheduled to the same backend server. 3TCH: 3-tuple hash. Consistent hashing based on the 3-tuple (source IP address, destination IP address, and protocol). Requests from the same flow are scheduled to the same backend server. 2TCH: 2-tuple hash. Consistent hashing based on the 2-tuple (source IP address and destination IP address). Requests from the same flow are scheduled to the same backend server. Valid values: 2TCH : 2-tuple hash. 5TCH : 5-tuple hash. 3TCH : 3-tuple hash.	5TCH
ServerFailoverMode	string	No	The processing method for existing traffic when a server exception occurs. Valid values: NoRebalance: Does not rebalance existing traffic. Rebalance: Rebalances existing traffic. Valid values: Rebalance : Rebalances existing traffic. NoRebalance : Does not rebalance existing traffic.	NoRebalance
ConnectionDrainConfig	object	No	The configuration for connection draining.
ConnectionDrainEnabled	boolean	No	Specifies whether to enable connection draining. Valid values: true: Enables connection draining. false: Disables connection draining.	false
ConnectionDrainTimeout	integer	No	The timeout period for connection draining. Unit: seconds. Valid values: 1 to 3600.	300
HealthCheckConfig	object	No	The health check configuration.
HealthCheckConnectPort	integer	No	The port of the backend server used for health checks. Valid values: 1 to 65535.	80
HealthCheckConnectTimeout	integer	No	The maximum timeout period for a health check response. Unit: seconds. Valid values: 1 to 300.	5
HealthCheckDomain	string	No	The domain name used for health checks. Valid values: $SERVER_IP: The internal IP address of the backend server. domain: A custom domain name. The domain name must be 1 to 80 characters in length, and can contain only letters, digits, hyphens (-), and periods (.). Note This parameter takes effect only when HealthCheckProtocol is set to HTTP.	$SERVER_IP
HealthCheckEnabled	boolean	No	Specifies whether to enable health checks. Valid values: true: Enables health checks. false: Disables health checks.	true
HealthCheckHttpCode	array	No	The list of HTTP status codes for healthy backend servers.
	string	No	The HTTP status codes for healthy backend servers. Separate multiple status codes with commas (,). Valid values: http_2xx: HTTP 2xx status codes indicate healthy backend servers. http_3xx: HTTP 3xx status codes indicate healthy backend servers. http_4xx: HTTP 4xx status codes indicate healthy backend servers. http_5xx: HTTP 5xx status codes indicate healthy backend servers. Default value: http_2xx. Note This parameter takes effect only when HealthCheckProtocol is set to HTTP. Valid values: http_4xx : HTTP 4xx status codes indicate healthy backend servers. http_3xx : HTTP 3xx status codes indicate healthy backend servers. http_5xx : HTTP 5xx status codes indicate healthy backend servers. http_2xx : HTTP 2xx status codes indicate healthy backend servers.	http_2xx
HealthCheckInterval	integer	No	The interval between two consecutive health checks. Unit: seconds. Valid values: 1 to 50.	10
HealthCheckPath	string	No	The health check path. The path must be 1 to 80 characters in length, and can contain only letters, digits, and the following special characters: `-/.%?#&`. It must start with a forward slash (/). Note This parameter takes effect only when HealthCheckProtocol is set to HTTP.	/test/index.html
HealthCheckProtocol	string	No	The protocol used for health checks. Valid values: TCP: Sends SYN handshake packets to check whether the server port is alive. HTTP: Sends GET requests to simulate browser access and check whether the server application is healthy.	TCP
HealthyThreshold	integer	No	The number of consecutive successful health checks that must occur before the health status of a backend server changes from Failed to Successful. Valid values: 2 to 10.	2
UnhealthyThreshold	integer	No	The number of consecutive failed health checks that must occur before the health status of a backend server changes from Successful to Failed. Valid values: 2 to 10.	2
HealthCheckReq	string	No
HealthCheckExp	string	No
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: Performs a dry run without updating the server group information. The system checks whether required parameters are specified, the request format is valid, and the service limits are met. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): Performs a dry run and sends the actual request. If the request passes the dry run, an HTTP 2xx status code is returned and the operation is performed.	false
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request is unique.	123e4567-e89b-12d3-a456-42665544****

Response elements

Element	Type	Description	Example
	object	The response struct.
RequestId	string	The ID of the request.	54B48E3D-DF70-471B-AA93-08E683A1B45

Examples

Success response

JSON format

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45\n"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.HealthCheckProtocol	The param of %s is illegal.	The health check protocol is invalid. Check the input parameters.
400	IncorrectStatus.ServerGroup	The status of %s [%s] is incorrect.	The status of %s [%s] is incorrect.
400	OperationDenied.SchedulerNotConfigurable	The scheduling algorithm of server group is configurable only when TCP idle timeout of listener is default value.	The scheduling algorithm of server group is configurable only when TCP idle timeout of listener is default value.
404	ResourceNotFound.ServerGroup	The specified resource of %s is not found.	The specified server group resource does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.