All Products
Search

This Product

    Server Load Balancer:AddServersToServerGroup

    Document Center

    Server Load Balancer:AddServersToServerGroup

    Last Updated:Dec 02, 2024

    Adds backend servers to the server group of a Gateway Load Balancer (GWLB) instance.

    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 the server group.
    • If the server group is in the Configuring state, the server group is being modified.
    • If the server group is in the Available state, the server group is running.
    1. You can call the ListServerGroupServers operation to query the status of the backend server.
    • If the backend server is in the Adding state, the backend server is being added to the server group.
    • If the backend server is in the Available state, the server is running.

    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
    gwlb:AddServersToServerGroupcreate
    *ServerGroup
    acs:gwlb:{#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 server group ID.

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

    The backend servers that you want to add.

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

    The backend server.

    PortintegerNo

    The backend server port. Valid values:

    • 6081
    		6081
    ServerIdstringYes

    The backend server ID.

    • If the server group is of the Instance type, set this parameter to the IDs of servers of the Ecs, Eni, or Eci type.
    • If the server group is of the Ip type, set ServerId to IP addresses.
    		i-bp67acfmxazb4p****
    ServerIpstringNo

    The IP address of the backend server.

    		192.168.XX.XX
    ServerTypestringYes

    The type of the backend server. Valid values:

    • Ecs: Elastic Compute Service (ECS) instance
    • Eni: elastic network interface (ENI)
    • Eci: elastic container instance
    • Ip: IP address
    		Ecs
    DryRunbooleanNo

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

    • true: performs only a dry run. 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
    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 client 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.
    		123e4567-e89b-12d3-a456-426655440000

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

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

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400Conflict.ServerThe %s [%s] is conflict.There is already %s having the same configuration with %s.
    400Mismatch.ServerTypeThe %s is mismatched for %s and %s.ServerType mismatch.
    400ResourceInUse.IPThe specified resource of %s is in use.The specified resource of IP is in use.
    400IllegalParam.ServerIpThe param of %s is illegal.The parameter ServerIp is invalid. Please check the input parameters.
    400IllegalParam.EcsNetworkTypeThe param of %s is illegal.-
    400DuplicatedParam.ServerThe param of %s is duplicated.Duplicate server in parameter.
    400ResourceInUse.EniThe specified resource of %s is in use.The passed-in eni cannot be the eni used by the gateway loadbalancer instance.Please check the parameters.
    400IncorrectStatus.EniThe status of %s [%s] is incorrect.Resource %s current state %s does not support operation
    400IllegalParam.IPThe param of %s is illegal.The parameter IP is invalid. Please check the input value of the parameter IP.
    400Mismatch.IPThe %s is mismatched for %s and %s.The entered IP type server ID and IP do not match.
    400Mismatch.VpcIdThe %s is mismatched for %s and %s.The VPC IDs of the two resources do not match.
    400QuotaExceeded.ServerGroupServersNumThe quota of %s is exceeded for resource %s, usage %s/%s.The quota gwlb_quota_servergroup_servers_num has exceeded the quota limit.
    400QuotaExceeded.ServerGroupAzServersNumThe quota of %s is exceeded for resource %s, usage %s/%s.The quota gwlb_quota_servergroup_az_servers_num has exceeded the quota limit.
    400IncorrectStatus.ServerGroupThe status of %s [%s] is incorrect.The status of %s [%s] is incorrect.
    404ResourceNotFound.EniThe specified resource of %s is not found.The specified elastic network interfaces resource does not exist.
    404ResourceNotFound.EciThe specified resource of %s is not found.The specified elastic container instance resource does not exist.
    404ResourceNotFound.ServerGroupThe specified resource of %s is not found.The specified server group resource does not exist.
    404ResourceNotFound.EcsThe specified resource of %s is not found.The specified ECS resource does not exist.

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