Updates the configurations of a server group, such as health checks, session persistence, name, scheduling algorithm, and health check protocol.
Operation description
The UpdateServerGroupAttribute operation is asynchronous. After you send the request, the system returns a request ID, but the server group configurations are not immediately updated. The update task runs in the background. You can call the ListServerGroups operation to query the update status of the server group configurations:
If the server group configurations are in the Configuring state, the configurations are being updated.
If the server group configurations are in the Available state, the configurations are updated.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
alb:UpdateServerGroupAttribute |
update |
*ServerGroup
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ServerGroupName |
string |
No |
The name of the server group. The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), hyphens (-), and spaces. It must start with a letter or a digit. |
test |
| Scheduler |
string |
No |
The scheduling algorithm. Valid values:
|
Wrr |
| 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 client token. The RequestId of each API request may be different. |
5A2CFF0E-5718-45B5-9D4D-70B3****** |
| DryRun |
boolean |
No |
Specifies whether to perform only a dry run. Valid values:
|
true |
| HealthCheckConfig |
object |
No |
The health check configuration struct. |
true |
| HealthCheckCodes |
array |
No |
The list of status codes that indicate a successful health check. |
|
|
string |
No |
The status codes that indicate a successful health check.
Note
This parameter takes effect only when HealthCheckEnabled is set to true and HealthCheckProtocol is set to HTTP, HTTPS, or gRPC for the server group. |
200 |
|
| HealthCheckConnectPort |
integer |
No |
The port of the backend server that is 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. Note
The parameter settings take effect only when HealthCheckEnabled is set to true for the server group. |
80 |
| HealthCheckEnabled |
boolean |
No |
Specifies whether to enable health checks. Valid values:
|
true |
| HealthCheckHost |
string |
No |
The domain name that is used for health checks.
Note
This parameter takes effect only when HealthCheckProtocol is set to HTTP, HTTPS, or gRPC. |
example.com |
| HealthCheckHttpVersion |
string |
No |
The HTTP version that is used for health checks. Valid values:
Note
This parameter takes effect only when HealthCheckEnabled is set to true and HealthCheckProtocol is set to HTTP or HTTPS for the server group. |
HTTP1.1 |
| HealthCheckInterval |
integer |
No |
The interval between two consecutive health checks. Unit: seconds. Valid values: 1 to 50. Note
The parameter settings take effect only when HealthCheckEnabled is set to true for the server group. |
5 |
| HealthCheckMethod |
string |
No |
The HTTP method that is used for health checks. Valid values:
Note
This parameter takes effect only when HealthCheckEnabled is set to true and HealthCheckProtocol is set to HTTP, HTTPS, or gRPC for the server group. |
HEAD |
| HealthCheckPath |
string |
No |
The path that is used for health checks. The path must be 1 to 80 characters in length, and can contain only letters, digits, the characters Note
This parameter takes effect only when HealthCheckEnabled is set to true and the HealthCheckProtocol settings are HTTP or HTTPS for the server group. |
/test/index.html |
| HealthCheckProtocol |
string |
No |
The protocol that is used for health checks. Valid values:
|
HTTP |
| HealthCheckTimeout |
integer |
No |
The timeout period to accept a response from a health check. If the backend ECS instance does not respond correctly within the specified time, the health check is failed. Unit: seconds. Valid values: 1 to 300. Note
The parameter settings take effect only when HealthCheckEnabled is set to true for the server group. |
3 |
| HealthyThreshold |
integer |
No |
The number of consecutive successful health checks that must occur before the health check status of a backend server changes from fail to success. Valid values: 2 to 10. |
4 |
| UnhealthyThreshold |
integer |
No |
The number of consecutive failed health checks that must occur before the health check status of a backend server changes from success to fail. Valid values: 2 to 10. |
4 |
| StickySessionConfig |
object |
No |
The session persistence configuration struct. |
|
| Cookie |
string |
No |
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 ($). Note
This parameter takes effect only when StickySessionEnabled is set to true and StickySessionType is set to Server for the server group. |
B490B5EBF6F3CD402E515D22B****** |
| CookieTimeout |
integer |
No |
The timeout period of the cookie. Unit: seconds. Valid values: 1 to 86400. Note
This parameter takes effect only when StickySessionEnabled is set to true and StickySessionType is set to Insert for the server group. |
1000 |
| StickySessionEnabled |
boolean |
No |
Specifies whether to enable session persistence. Valid values:
|
false |
| StickySessionType |
string |
No |
The method that is used to handle cookies. Valid values:
Note
This parameter takes effect only when StickySessionEnabled is set to true for the server group. |
Insert |
| ServerGroupId |
string |
Yes |
The ID of the server group. |
sgp-atstuj3rtop**** |
| UpstreamKeepaliveEnabled |
boolean |
No |
Specifies whether to enable backend keep-alive. Valid values:
|
false |
| ServiceName |
string |
No |
This parameter is applicable only to ALB Ingress scenarios and specifies the name of the |
test2 |
| UchConfig |
object |
No |
The URL consistent hashing parameter settings. |
|
| Type |
string |
Yes |
The parameter type. Only QueryString is supported. |
QueryString |
| Value |
string |
Yes |
The consistent hashing parameter value. |
abc |
| ConnectionDrainConfig |
object |
No |
The graceful connection break configuration. After the graceful connection break is enabled, load balancing allows existing connections to be normally transmitted within a specified period after a backend server is removed or a health check is failed. Note
|
|
| ConnectionDrainEnabled |
boolean |
No |
Specifies whether to enable connection draining. Valid values:
|
false |
| ConnectionDrainTimeout |
integer |
No |
The connection draining timeout period. Valid values: 0 to 900. |
300 |
| SlowStartConfig |
object |
No |
The slow start configuration. After slow start is enabled, newly added backend servers in the backend server group are warmed up within the specified time period, and the number of requests forwarded to the servers increases linearly. Note
|
|
| SlowStartDuration |
integer |
No |
The slow start duration. Valid values: 30 to 900. |
30 |
| SlowStartEnabled |
boolean |
No |
Specifies whether to enable slow start. Valid values:
|
false |
| CrossZoneEnabled |
boolean |
No |
Specifies whether to enable cross-zone load balancing for the server group. Valid values:
Note
|
true |
| IpVersionAffinityMode |
string |
No |
The IP version affinity mode. Valid values:
This parameter takes effect only when Ipv6Enabled is set to true. |
Affinity |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response data structure. |
||
| JobId |
string |
The ID of the asynchronous task. |
72dcd26b-f12d-4c27-b3af-18f6aed5**** |
| RequestId |
string |
The request ID. |
365F4154-92F6-4AE4-92F8-7FF3***** |
Examples
Success response
JSON format
{
"JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
"RequestId": "365F4154-92F6-4AE4-92F8-7FF3*****"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | IncorrectStatus.ServerGroup | The status of %s [%s] is incorrect. | The status of %s [%s] is incorrect. |
| 400 | Mismatch.LoadBalancerEditionAndConnectionDrain | The %s and %s are mismatched. | The %s and %s are mismatched. |
| 400 | Mismatch.ServerGroupSchedulerAndSlowStartEnable | The %s and %s are mismatched. | The %s and %s are mismatched. |
| 400 | QuotaExceeded.ConnectionDrainTimeout | The quota of %s is exceeded, usage %s/%s. | The quota of %s is exceeded, usage %s/%s. |
| 400 | UnsupportedFeature.ConnectionDrain | The feature of %s is not supported. | The feature of %s is not supported. |
| 400 | QuotaExceeded.SlowStartDuration | The quota of %s is exceeded, usage %s/%s. | The quota of %s is exceeded, usage %s/%s. |
| 400 | UnsupportedFeature.SlowStart | The feature of %s is not supported. | The feature %s is not supported. |
| 400 | Mismatch.LoadBalancerEditionAndSlowStartEnable | The %s and %s are mismatched. | The %s and %s are mismatched. |
| 400 | OperationDenied.UpstreamKeepaliveDisabled | The operation is not allowed because of UpstreamKeepaliveDisabled. | Updating not allowed Backend long connection is closed |
| 400 | OperationDenied.UpstreamKeepaliveEnabled | The operation is not allowed because of UpstreamKeepaliveEnabled. | Update not allowed to open Backend Long connection is in the open state |
| 400 | CloseUpstreamKeepaliveNotSupport | The param of UpstreamKeepalive is not Support. | close keepalive attribute for server group is not supported |
| 400 | OperationDenied.VpcNotSupportIpv6 | The operation is not allowed because of VpcNotSupportIpv6. | The operation is not allowed because of VpcNotSupportIpv6. |
| 400 | OperationDenied.Ipv6ServerExists | IPv6 backend servers exist in the specified server group. | IPv6 backend servers exist in the specified server group. |
| 404 | ResourceNotFound.ServerGroup | The specified resource %s is not found. | The backend server group does not exist. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.