Add backend servers to a server group using AddServersToServerGroup - Server Load Balancer - Alibaba Cloud - Server Load Balancer

Adds backend servers to a 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:AddServersToServerGroup

create

*ServerGroup

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

Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#InstanceId}

NetworkInterface

acs:ecs:{#regionId}:{#accountId}:eni/{#ServerId}

ContainerGroup

acs:eci:{#regionId}:{#accountId}:containergroup/{#ServerId}

None

Request parameters

Parameter	Type	Required	Description	Example
ServerGroupId	string	Yes	The server group ID.	sgp-atstuj3rtoptyui****
Servers	array<object>	Yes	The backend servers to add. Note You can add up to 200 backend servers in each call.
	object	No	The backend server to add. Note You can add up to 200 backend servers in each call.
ServerId	string	Yes	The backend server ID. If the server group is of the Instance type, set this parameter to the IDs of Elastic Compute Service (ECS) instances, elastic network interfaces (ENIs), or elastic container instances. If the server group is of the Ip type, set ServerId to IP addresses.	i-bp67acfmxazb4p****
ServerType	string	Yes	The type of the backend server. Valid values: Ecs: the ECS instance Eni: the ENI Eci: the elastic container instance Ip: the IP address	Ecs
ServerIp	string	No	The IP address of the backend server. If the server group type is Ip, set ServerId to an IP address.	192.168.6.6
Port	integer	No	The port used by the backend server. Valid values: 0 to 65535. Default value: 0. If multi-port forwarding is enabled, you do not need to set this parameter. The default value 0 is used, and NLB forwards requests to the requested ports. To check whether multi-port forwarding is enabled, call the ListServerGroups operation and check the value of the AnyPortEnabled parameter.	443
Weight	integer	No	The weight of the backend server. Valid values: 0 to 100. Default value: 100. If this parameter is set to 0, no requests are forwarded to the server.	100
Description	string	No	The description of the backend server. The description must be 2 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).	ECS
RegionId	string	No	The ID of the region where the NLB instance is deployed. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
DryRun	boolean	No	Whether to perform a dry run. Valid values: true: validates the request without performing the operation. The system checks for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails validation, the corresponding error message is returned. If the request passes validation, the `DryRunOperation` error code is returned. false (default): validates the request and performs the operation. If the request passes validation, a 2xx HTTP status code is returned and the operation is performed.	false
ClientToken	string	No	The client token that ensures the idempotence of the request. You can use the client to generate the token. Ensure that the token is unique among different requests. The token can contain only ASCII characters. Note If you do not set this parameter, the value of RequestId is used. The value of RequestId is different for each request.	123e4567-e89b-12d3-a456-426655440000

Response elements

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

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	Conflict.Lock	The Lock [%s] is conflict.	The specific resource is conflict.
400	IllegalParam.IP	The param of IP is illegal.	The parameter IP is invalid. Please check the input value of the parameter IP.
400	QuotaExceeded.QuotaInsufficient	The quota of %s is exceeded, usage %s/%s.	The quota is insufficient, currently used %s/%s. Please modify the quota size in the quota center.
400	SystemBusy	System is busy, please try again later.
400	DuplicatedParam.Server	The param of Server is duplicated.	The param of Server is duplicated.
400	IncorrectStatus.serverGroup	The status of servergroup [%s] is incorrect.	The current operation cannot be performed on the server group as its status is unavailable. Please check if the server group is currently undergoing any other operations.
400	Mismatch.VpcId	The VpcId is mismatched for %s and %s.	The VpcId is mismatched for %s and %s.
400	Mismatch.ServerType	The ServerType is mismatched for %s and %s.
400	IllegalParam.RSPortConflictWithServerGroup	The param of RSPortConflictWithServerGroup is illegal.	The parameter RSPort conflicts with the ServerGroup.
400	TagInvokeError	listTagsByResourceIds: InvalidResourceId.NotFound : The specified ResourceIds are not found in our records.
400	ResourceInUse.IP	The specified resource of IP is in use.
400	IllegalParam	The param of %s is illegal.
400	MissingParam.%s	The parameter of %s is missing.
400	IllegalParam.description	The parameter description of server is illegal.	The server description does not meet the input requirements, please modify according to the details in the error.
400	MissingParam.IP	The param of IP is missing.	The entered IP parameter is missing. Check your input parameter.
400	OperationDenied.ServerGroupNotSupportIpv6	The operation is not allowed because of ServerGroupNotSupportIpv6.	The operation failed because the server group does not support IPV6.
400	IncorrectStatus.Eni	Eni status is invalid.	The ENI status is invalid.
400	IdempotenceSignatureMismatch	The idempotence token of request is same with the prev one, but the signature is different.	The requested idempotent token is the same as the previous one, but the signature is different.
400	Throttling.User	Request was denied due to api flow control.	Request was denied due to api flow control.
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.
404	ResourceNotFound.Eci	The specified resource of Eci is not found.	The specified ECI (Elastic Container Instance) resource was not found. Please check the input parameters.
404	ResourceNotFound.Ecs	The specified resource of Ecs is not found.	The specified ECS (Elastic Compute Service) resource was not found. Please check the input parameters.
404	ResourceNotFound.Eni	The specified resource Eni is not found.	The specified ENI instance is not found. Check the input parameters.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.