Modifies the configurations of backend servers in a server group, such as the weight and description.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | UpdateServerGroupServersAttribute |
The operation that you want to perform. Set the value to UpdateServerGroupServersAttribute. |
ServerGroupId | String | Yes | sgp-atstuj3rtop**** |
The ID of the server group. |
Servers | Array | Yes |
The backend servers whose configurations you want to modify. You can specify up to 40 backend servers in each call. |
|
Description | String | No | test |
The description of the backend server. The description must be 2 to 256 characters in length and can contain letters, digits, periods (.), underscores (_), hyphens (-), commas (,), semicolons (;), forward slashes (/), and at signs (@). |
Port | Integer | No | 80 |
The port used by the backend server. Valid values: 1 to 65535. Note You do not need to specify this parameter if ServerType is set to Fc.
|
ServerId | String | Yes | i-bp1f9kdprbgy9uiu**** |
The ID of the backend server.
|
ServerIp | String | No | 192.168.1.1 |
The IP address in inclusive ENI mode. |
ServerType | String | Yes | Ecs |
The type of the backend server. Valid values:
|
Weight | Integer | No | 100 |
The weight of the backend server. Valid values: 0 to 100. Default value: 100. If the weight of a backend server is set to 0, no requests are forwarded to the backend server. Note You do not need to specify this parameter if ServerType is set to Fc.
|
ClientToken | String | No | 593B0448-D13E-4C56-AC0D-FDF0FDE0E9A3 |
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 make sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. Note If you do not set this parameter, the system automatically uses RequestId as ClientToken. RequestId may be different for each API request.
|
DryRun | Boolean | No | false |
Specifies whether to only precheck this request. Valid values:
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
JobId | String | 72dcd26b-f12d-4c27-b3af-18f6aed5**** |
The ID of the asynchronous task. |
RequestId | String | 365F4154-92F6-4AE4-92F8-7FF34B540710 |
The ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=UpdateServerGroupServersAttribute
&ServerGroupId=sgp-atstuj3rtop****
&Servers=[{"Description":"test","Port":80,"ServerId":"ecs-bp67acfmxazb4p****","ServerIp":"192.168.1.1","ServerType":"Ecs","Weight":100}]
&ClientToken=593B0448-D13E-4C56-AC0D-FDF0FDE0E9A3
&DryRun=false
&Common request parameters
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<UpdateServerGroupServersAttributeResponse>
<JobId>72dcd26b-f12d-4c27-b3af-18f6aed5****</JobId>
<RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
</UpdateServerGroupServersAttributeResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"JobId" : "72dcd26b-f12d-4c27-b3af-18f6aed5****",
"RequestId" : "365F4154-92F6-4AE4-92F8-7FF34B540710"
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | IncorrectStatus.ServerGroup | The status of %s [%s] is incorrect. | The error message returned because the server group is in a state that does not support the operation. |
404 | ResourceNotFound.ServerGroup | The specified resource %s is not found. | The error message returned because the specified resource %s does not exist. |
For a list of error codes, visit the API Error Center.