All Products
Search

This Product

    Server Load Balancer:AddServersToServerGroup

    Document Center

    Server Load Balancer:AddServersToServerGroup

    Last Updated:Jul 25, 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.

    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:AddServersToServerGroupcreate
    • ServerGroup
      acs:alb:{#regionId}:{#accountId}:servergroup/{#servergroupId}
    • Instance
      acs:alb:{#regionId}:{#accountId}:ecs/{#InstanceId}
    • NetworkInterface
      acs:alb:{#regionId}:{#accountId}:eni/{#NetworkInterfaceId}
    • ContainerGroup
      acs:alb:{#regionId}:{#accountId}:eci/{#ContainerGroupId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ServerGroupIdstringYes

    The server group ID.

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

    The backend servers. You can specify at most 200 servers in each call.

    objectYes

    The configurations of the backend server.

    DescriptionstringNo

    The description of the backend server. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

    		test
    PortintegerNo

    The port that is used by the backend server. Valid values: 1 to 65535. You can specify at most 200 servers in each call.

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

    The ID of the server group. You can specify at most 200 servers in each call.

    • If the server group is of the Instance type, set ServerId to the ID of a resource of the Ecs, Eni, or Eci type.
    • If the server group is of the Ip type, set this parameter to IP addresses.
    • If the server group is of the Fc type, set ServerId to an Alibaba Cloud Resource Name (ARN).
    		ecs-bp67acfmxazb4p****
    ServerIpstringNo

    The IP address of the backend server. You can specify at most 200 servers in each call.

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

    The type of the backend server. You can specify at most 200 servers in each call. Default values:

    • Ecs: Elastic Compute Service (ECS) instance
    • Eni: elastic network interface (ENI)
    • Eci: elastic container instance
    • Ip: IP address
    • Fc: Function Compute
    		Ecs
    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. You can specify at most 200 servers in each call.

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

    Specifies whether to enable the remote IP feature. You can specify at most 200 servers in each call. Default values:

    • true: enables the feature.
    • false: disables the feature.
    Note This parameter takes effect only when ServerType is set to Ip.
    		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.
    400ResourceQuotaExceeded.LoadBalancerServersNumThe quota of %s is exceeded for resource %s, usage %s/%s.The quota of %s is exceeded for resource %s. Usage: %s/%s.
    400ResourceInConfiguringThe specified resource of %s is being configured. Please try again later.-
    400DuplicatedParam.BackendServerThe param of %s is duplicated.The param of %s is duplicated.
    400OperationDenied.EciNotSupportJobTypeThe operation is not allowed because of eci not support job type.The operation is not allowed because of eci not support job type.
    400IllegalParam.ServerIpThe param of ServerIp is illegal.-
    400Mismatch.ServerTypeThe %s is mismatched for %s and %s.-
    400ServiceUnavailableThe request has failed due to a temporary failure of the server.The request has failed due to a temporary failure of the server.
    403Forbidden.ServerGroupAuthentication has failed for ServerGroup.-
    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
    2024-01-29The Error code has changedView Change Details
    2024-01-29The 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-24The Error code has changedView Change Details
    2024-01-18The Error code has changedView Change Details
    2023-07-20The Error code has changedView Change Details