Update server group attributes using UpdateServerGroupAttribute - Server Load Balancer - Alibaba Cloud - Server Load Balancer

Updates the configuration of a Network Load Balancer (NLB) server group.

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

nlb:UpdateServerGroupAttribute

update

*ServerGroup

acs:nlb:{#regionId}:{#accountId}:servergroup/{#ServerGroupId}

None

Request parameters

Parameter	Type	Required	Description	Example
ServerGroupId	string	Yes	The ID of the server group.	sgp-atstuj3rtoptyui****
ServerGroupName	string	No	The new name of the server group. The name must be 2 to 128 characters in length and must start with a letter or a Chinese character. It can contain digits, periods (.), underscores (_), and hyphens (-).	NLB_ServerGroup1
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: 0 to 900.	10
Scheduler	string	No	The scheduling algorithm. Valid values: Wrr: weighted round-robin. Backend servers with higher weights receive more requests. Wlc: weighted least connections. Requests are distributed based on the weights and actual loads (number of connections) of backend servers. If two backend servers have the same weight, the backend server with fewer connections receives more requests. rr: round-robin. Requests are distributed to backend servers in sequence. sch: source IP hash. Requests from the same source IP address are distributed to the same backend server. tch: 4-tuple hash. Consistent hashing based on the 4-tuple (source IP address, destination IP address, source port, and destination port). Requests from the same flow are distributed to the same backend server. qch: QUIC ID hash. Requests with the same QUIC ID are distributed to the same backend server. Note QUIC ID hash is supported only when the backend protocol is UDP.	Wrr
IpVersionAffinityMode	string	No	The traffic scheduling policy in dual-stack mode. Valid values: NonAffinity (default): non-affinity mode. Requests are forwarded to healthy backend servers based on the scheduling algorithm regardless of the IP protocol version of the source. Affinity: affinity mode. Requests are forwarded based on the IP protocol version of the source. IPv4 requests are forwarded only to IPv4 backend servers, and IPv6 requests are forwarded only to IPv6 backend servers. Note This parameter takes effect only when AddressIPVersion is set to DualStack.	Affinity
PreserveClientIpEnabled	boolean	No	Specifies whether to enable client IP preservation. Valid values: true: enables client IP preservation. false: disables client IP preservation. Note If PreserveClientIpEnabled is set to false and the server group is associated with a TCPSSL listener, you cannot change the value of this parameter to true.	false
HealthCheckConfig	object	No	The health check configuration.
HealthCheckConnectPort	integer	No	The port of the backend server used for health checks. Valid values: 0 to 65535. A value of 0 indicates that the port of the backend server is used for health checks.	0
HealthCheckConnectTimeout	integer	No	The maximum timeout period for a health check response. Unit: seconds. Valid values: 1 to 300. Default value: 5.	100
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 lowercase letters, digits, hyphens (-), and periods (.). Note This parameter takes effect only when HealthCheckType 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.	false
HealthCheckExp	string	No	The response string for UDP listener health checks. The string can contain only letters and digits, and can be up to 512 characters in length.	ok
HealthCheckHttpCode	array	No	The HTTP status codes for healthy responses. Separate multiple HTTP status codes with commas (,). Valid values: http_2xx (default), http_3xx, http_4xx, and http_5xx. Note This parameter takes effect only when HealthCheckType is set to HTTP.
	string	No	The HTTP status codes for healthy responses. Separate multiple HTTP status codes with commas (,). Valid values: http_2xx (default), http_3xx, http_4xx, and http_5xx. Note This parameter takes effect only when HealthCheckType is set to HTTP.	http_2xx
HealthCheckHttpVersion	string	No	The HTTP protocol version for health checks. Valid values: HTTP1.0 and HTTP1.1. Note This parameter takes effect only when HealthCheckType is set to HTTP.	HTTP1.0
HealthCheckInterval	integer	No	The interval between two consecutive health checks. Unit: seconds. Default value: 5. If HealthCheckType is set to TCP or HTTP, valid values are 1 to 50. If HealthCheckType is set to UDP, valid values are 1 to 300. The interval must be greater than or equal to the response timeout period to ensure that UDP probe responses are not mistakenly considered as no response due to timeout.	5
HealthCheckReq	string	No	The request string for UDP listener health checks. The string can contain only letters and digits, and can be up to 512 characters in length.	hello
HealthCheckType	string	No	The protocol used for health checks. Valid values: TCP HTTP UDP	TCP
HealthCheckUrl	string	No	The health check path. The path must be 1 to 80 characters in length. It can contain only letters, digits, the characters `-/.%?#&=`, and extension characters `_;~!()[]@$^:',+`. It must start with a forward slash (/). Note* This parameter takes effect only when HealthCheckType is set to HTTP.	/test/index.html
HealthyThreshold	integer	No	The number of consecutive successful health checks required to change the health check status of a backend server from Failed to Successful. Valid values: 2 to 10.	3
HttpCheckMethod	string	No	The HTTP method used for health checks. Valid values: GET and HEAD. Note This parameter takes effect only when HealthCheckType is set to HTTP.	GET
UnhealthyThreshold	integer	No	The number of consecutive failed health checks required to change the health check status of a backend server from Successful to Failed. Valid values: 2 to 10.	3
RegionId	string	No	The region ID of the Network Load Balancer (NLB) instance. You can call the DescribeRegions operation to retrieve the region ID.	cn-hangzhou
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run and does not update the server group. 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 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 token, but you must make sure that the token 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-426655440000

Response elements

Element	Type	Description	Example
	object	The server group configuration.
JobId	string	The ID of the asynchronous task.	72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestId	string	The ID of the request.	54B48E3D-DF70-471B-AA93-08E683A1B45
ServerGroupId	string	The ID of the server group.	sgp-atstuj3rtoptyui****

Examples

Success response

JSON format

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "ServerGroupId": "sgp-atstuj3rtoptyui****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.%s	The param of %s is illegal.	The parameter %s is invalid.
400	SystemBusy	System is busy, please try again later.	The system is busy. Try again later.
400	IllegalParam.healthCheckDomain	The parameter of healthCheckConfig.healthCheckDomain is illegal.	The healthCheckDomain in the health check configuration is invalid. Check the input parameters.
400	IlleagalParam.healthCheckUrl	The parameter of healthCheckUrl in healthCheckConfig is illegal.	The URL of the health check used in the health check setting is invalid.
400	OperationDenied.UidNotAllowQuic29	The operation is not allowed because of uid not allow quic29 version.
400	IllegalParam	The param of %s is illegal.	The input parameters contain invalid values. Check the input.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	Request validation has been passed with DryRun flag set.
400	IllegalParam.ServerGroupName	The param of ServerGroupName is illegal.	The ServerGroupName parameter is invalid.
400	IllegalParam.PreserveClientIpSwitch	The server group associated with the tcpssl listener does not support enabling PreserveClientIp.	The server group associated with the TCPSSL listener does not support client IP retention.
403	Forbidden.NoPermission	Authentication is failed for NoPermission.	Authentication is failed for NoPermission.
404	ResourceNotFound.serverGroup	The specified resource of serverGroup is not found.	The specified resource of serverGroup is not found. Please check the input parameters.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.