All Products
Search
Document Center

Server Load Balancer:AddServersToServerGroup

Last Updated:Jan 09, 2024

Adds backend servers to a server group.

Operation description

AddServersToServerGroup is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background.

  1. You can call the ListServerGroups operation to query the status of a server group.
  • If a server group is in the Configuring state, it indicates that the server group is being modified.
  • If a server group is in the Available state, it indicates that the server group is running.
  1. You can call the ListServerGroupServers operation to query the status of a backend server.
  • If a backend server is in the Adding state, it indicates that the backend server is being added to a server group.
  • If a backend server is in the Available state, it indicates that the server is running.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
alb:AddServersToServerGroupWrite
  • ServerGroup
    acs:alb:{#regionId}:{#accountId}:servergroup/{#servergroupId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ServerGroupIdstringYes

The server group ID.

sgp-atstuj3rtop****
Serversobject []Yes

The backend servers that you want to add to the server group. You can specify up to 40 backend servers in each call.

DescriptionstringNo

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 (@). You can specify up to 40 servers in each call.

test
PortintegerNo

The port used by the backend server. Valid values: 1 to 65535. You can specify up to 40 server IDs in each call.

Note This parameter is required if the ServerType parameter is set to Ecs, Eni, Eci, or Ip. You do not need to set this parameter if ServerType is set to Fc.
80
ServerIdstringYes

The backend server ID. You can specify up to 40 server IDs in each call.

  • If ServerType is set to Instance, set the ServerId parameter to the ID of an Elastic Compute Service (ECS) instance, an elastic network interface (ENI), or an elastic container instance. These backend servers are specified by Ecs, Eni, or Eci.
  • If ServerType is set to Ip, set the ServerId parameter to an IP address specified in the server group.
  • If the backend server group is of the Fc type, set this parameter to the Alibaba Cloud Resource Name (ARN) of a function.
ecs-bp67acfmxazb4p****
ServerIpstringNo

The IP address in inclusive ENI mode. You can specify up to 40 server IDs in each call.

Note You do not need to set this parameter if ServerType is set to Fc.
192.168.1.1
ServerTypestringYes

The type of the backend server that you want to add to the server group. You can specify up to 40 server IDs in each call. Valid values:

  • Ecs
  • Eni
  • Eci
  • Ip
  • fc
Ecs
WeightintegerNo

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. You can specify up to 40 server IDs in each call.

Note You do not need to set this parameter if ServerType is set to Fc.
100
RemoteIpEnabledbooleanNo

Specifies whether to enable the remote IP address feature. You can specify up to 40 server IDs in each call. Valid values:

  • true
  • false

Regions that support the remote IP address feature: China (Hangzhou), China (Shenzhen), China (Qingdao), China (Beijing), China (Zhangjiakou), China (Ulanqab), China (Shanghai), China (Chengdu), China (Guangzhou), China (Hong Kong), US (Virginia), Japan (Tokyo), UK (London), US (Silicon Valley), Germany (Frankfurt), Indonesia (Jakarta), Singapore, Malaysia (Kuala Lumpur), Australia (Sydney), and India (Mumbai).

Note If ServerType is set to Ip, this parameter is available.
false
ClientTokenstringNo

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 token can contain only ASCII characters.

Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
593B0448-D13E-4C56-AC0D-FDF0FDE0E9A3
DryRunbooleanNo

Specifies whether to perform only a dry run, without performing the actual request. Valid values:

  • true: prechecks the request, but does not add a backend server to a server group. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error code is returned. If the request passes the dry run, the DryRunOperation error code is returned.
  • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
false

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

JobIdstring

The ID of the asynchronous job.

72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestIdstring

The request ID.

365F4154-92F6-4AE4-92F8-7FF34B540710

Examples

Sample success responses

JSONformat

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710"
}

Error codes

HTTP status codeError codeError messageDescription
400ResourceQuotaExceeded.ServerAddedNumThe quota of %s is exceeded for resource %s, usage %s/%s.The quota of %s is exceeded for resource %s, usage %s/%s.
400IncorrectStatus.ServerGroupThe status of %s [%s] is incorrect.The status of %s [%s] is incorrect.
400Conflict.BackendServerThere is already %s having the same configuration with %s.There is already %s having the same configuration with %s.
400OperationDenied.VpcVportNotFoundThe operation is not allowed because of %s.The operation is not allowed because of %s.
400IncorrectStatus.EniThe status of %s [%s] is incorrect.The status of %s [%s] is incorrect.
400ResourceInUse.IPThe specified resource %s is in use.The specified resource %s is in use.
400OperationDenied.NoAvailableVSwitchThe operation is not allowed because of %s.The operation is not allowed because of %s.
400OperationDenied.VgwVipNotFoundThe operation is not allowed because of %s.The operation is not allowed because of %s.
400OperationDenied.CloudBoxThe operation is not allowed because of %s.The operation is not allowed because of %s.
400Mismatch.TypeThe %s is mismatched for %s and %s.The %s is mismatched for %s and %s.
400Mismatch.VpcIdThe %s is mismatched for %s and %s.The %s is mismatched for %s and %s.
404ResourceNotFound.ServerGroupThe specified resource %s is not found.The specified resource %s is not found.
404ResourceNotFound.EcsThe specified resource %s is not found.The specified resource %s is not found.
404ResourceNotFound.EciThe specified resource %s is not found.The specified resource %s is not found.
404ResourceNotFound.EniThe specified resource %s is not found.The specified resource %s is not found.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-07-20The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 404