All Products
Search

This Product

    Server Load Balancer:AddServersToServerGroup

    Document Center

    Server Load Balancer:AddServersToServerGroup

    Last Updated:Oct 12, 2024

    Adds backend servers to a specified server group.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    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
    nlb:AddServersToServerGroupcreate
    • 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
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ServerGroupIdstringYes

    The ID of the server group.

    		sgp-atstuj3rtoptyui****
    Serversarray<object>Yes

    The backend servers.

    Note You can add at most 200 backend servers in each call.
    ServerobjectYes

    A list of backend servers.

    ServerIdstringYes

    The ID of the server group.

    • 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 this parameter to IP addresses.
    		i-bp67acfmxazb4p****
    ServerTypestringYes

    The type of the backend server. Valid values:

    • Ecs: ECS instance
    • Eni: ENI
    • Eci: elastic container instance
    • Ip: IP address
    		Ecs
    ServerIpstringNo

    The IP addresses of servers. If the server group type is Ip, set the ServerId parameter to IP addresses.

    		192.168.6.6
    PortintegerNo

    The port that is used by the backend server. Valid values: 0 to 65535. If you do not specify a port, the default value 0 is used.

    If you enable all-port forwarding, you do not need to specify a port when you add a backend server. The default port is port 0. NLB forwards requests to the requested ports. To determine whether all-port forwarding is enabled, call the ListServerGroups API operation and check the value of the AnyPortEnabled parameter.

    		443
    WeightintegerNo

    The weight of the backend server. Valid values: 0 to 100. Default value: 100. If the value is set to 0, no requests are forwarded to the server.

    		100
    DescriptionstringNo

    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 sings (@), underscores (_), and hyphens (-).

    		ECS
    RegionIdstringNo

    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
    DryRunbooleanNo

    Specifies whether only to precheck the request. Valid values:

    • true: prechecks the request but does not add the servers to the server group. The system prechecks the required parameters, request syntax, and limits. If the request fails the precheck, an error message is returned. If the request passes the precheck, the DryRunOperation error code is returned.
    • false (default): sends the request. If the request passes the precheck, an HTTP 2xx status code is returned and the operation is performed.
    		false
    ClientTokenstringNo

    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 all requests. ClientToken can contain only ASCII characters.

    Note If you do not set this parameter, ClientToken is set to the value of RequestId. The value of RequestId of each API request may be different.
    		123e4567-e89b-12d3-a456-426655440000

    Response parameters

    ParameterTypeDescriptionExample
    object

    RpcResponse

    RequestIdstring

    The ID of the request.

    		54B48E3D-DF70-471B-AA93-08E683A1B45
    ServerGroupIdstring

    The ID of the server group.

    		sgp-atstuj3rtoptyui****
    JobIdstring

    The ID of the asynchronous task.

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

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400Conflict.LockThe Lock [%s] is conflict.The specific resource is conflict.
    400IllegalParam.IPThe param of IP is illegal.The parameter IP is invalid. Please check the input value of the parameter IP.
    400QuotaExceeded.QuotaInsufficientThe 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.
    400SystemBusySystem is busy, please try again later.-
    400DuplicatedParam.ServerThe param of Server is duplicated.The param of Server is duplicated.
    400IncorrectStatus.serverGroupThe 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.
    400Mismatch.VpcIdThe VpcId is mismatched for %s and %s.The VpcId is mismatched for %s and %s.
    400Mismatch.ServerTypeThe ServerType is mismatched for %s and %s.-
    400IllegalParam.RSPortConflictWithServerGroupThe param of RSPortConflictWithServerGroup is illegal.The parameter RSPort conflicts with the ServerGroup.
    400TagInvokeErrorlistTagsByResourceIds: InvalidResourceId.NotFound : The specified ResourceIds are not found in our records.-
    400ResourceInUse.IPThe specified resource of IP is in use.-
    400IllegalParamThe param of %s is illegal.-
    400MissingParam.%sThe parameter of %s is missing.-
    400IllegalParam.descriptionThe parameter description of server is illegal.The server description does not meet the input requirements, please modify according to the details in the error.
    400MissingParam.IPThe param of IP is missing.The entered IP parameter is missing. Check your input parameter.
    400OperationDenied.ServerGroupNotSupportIpv6The operation is not allowed because of ServerGroupNotSupportIpv6.The operation failed because the server group does not support IPV6.
    400IncorrectStatus.EniEni status is invalid.The ENI status is invalid.
    400IdempotenceSignatureMismatchThe 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.
    400Throttling.UserRequest was denied due to api flow control.Request was denied due to api flow control.
    403Forbidden.NoPermissionAuthentication is failed for NoPermission.Authentication is failed for NoPermission.
    404ResourceNotFound.serverGroupThe specified resource of serverGroup is not found.The specified resource of serverGroup is not found. Please check the input parameters.
    404ResourceNotFound.EciThe specified resource of Eci is not found.The specified ECI (Elastic Container Instance) resource was not found. Please check the input parameters.
    404ResourceNotFound.EcsThe specified resource of Ecs is not found.The specified ECS (Elastic Compute Service) resource was not found. Please check the input parameters.
    404ResourceNotFound.EniThe specified resource Eni is not found.The specified ENI instance is not found. Check the input parameters.

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

    Change history

    Change timeSummary of changesOperation
    2024-04-02The Error code has changedView Change Details
    2024-01-29The Error code has changedView Change Details
    2024-01-24The Error code has changedView Change Details
    2024-01-22The Error code has changedView Change Details
    2023-10-30The Error code has changedView Change Details
    2023-10-07The Error code has changedView Change Details
    2023-09-26The Error code has changedView Change Details
    2023-09-13The Error code has changedView Change Details
    2023-09-05The Error code has changedView Change Details
    2023-08-22The Error code has changedView Change Details
    2023-08-22The Error code has changedView Change Details