All Products
Search

This Product

    Server Load Balancer:AddServersToServerGroup

    Document Center

    Server Load Balancer:AddServersToServerGroup

    Last Updated:Mar 13, 2024

    Adds backend servers to a server group of a Network Load Balancer (NLB) instance.

    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
    nlb:AddServersToServerGroupWrite
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ServerGroupIdstringYes

    The ID of the server group.

    		sgp-atstuj3rtoptyui****
    Serversobject []Yes

    A list of backend servers.

    ServerIdstringYes

    The ID of the server. You can specify at most 40 server IDs in each call.

    • If the server group type is 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 the server group type is Ip, set the ServerId parameter to an IP address.
    		ecs-bp67acfmxazb4p****
    ServerTypestringYes

    The type of the backend server. Valid values:

    • Ecs: an ECS instance
    • Eni: an ENI
    • Eci: an elastic container instance
    • Ip: an IP address
    Note You can specify at most 40 servers in each call.
    		Ecs
    ServerIpstringNo

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

    Note You can specify at most 40 server IP addresses in each call.
    		192.168.6.6
    PortintegerNo

    The port used by the backend server. Valid values: 1 to 65535.

    Note You can specify at most 40 servers in each call.
    		443
    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.

    Note You can specify at most 40 servers in each call.
    		100
    DescriptionstringNo

    The description of the servers.

    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 (-).

    Note You can specify at most 40 servers in each call.
    		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 message
    400Conflict.%sThe %s [%s] is conflict.
    400IllegalParam.%sThe param of %s is illegal.
    400QuotaExceeded.%sThe quota of %s is exceeded, usage %s/%s.
    400SystemBusySystem is busy, please try again later.
    400DuplicatedParam.%sThe param of %s is duplicated.
    400IncorrectStatus.%sThe status of %s [%s] is incorrect.
    400Mismatch.%sThe %s is mismatched for %s and %s.
    403Forbidden.%sAuthentication is failed for %s.
    404ResourceNotFound.%sThe specified resource of %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 changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
    2024-01-24The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
    2024-01-22The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
    2023-10-30The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
    2023-10-07The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
    2023-09-26The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
    2023-09-13The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
    2023-09-05The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      Error Codes 403 change
      Error Codes 404 change
    2023-08-22The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
    2023-08-22The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Added Error Codes: 400
      Added Error Codes: 403
      Added Error Codes: 404