All Products
Search

This Product

    Server Load Balancer:UpdateServerGroupServersAttribute

    Document Center

    Server Load Balancer:UpdateServerGroupServersAttribute

    Last Updated:Mar 13, 2024

    Modifies the weights and descriptions of backend servers in a server group of a Network Load Balancer (NLB) instance.

    Operation description

    UpdateServerGroupServersAttribute 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, the server group is being modified.
      • If a server group is in the Available state, the server group is running.

    2. You can call the ListServerGroupServers operation to query the status of a backend server.

      • If a backend server is in the Configuring state, it indicates that the backend server is being modified.
      • If a backend server is in the Available state, it indicates that the backend 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

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ServerGroupIdstringYes

    The server group ID.

    		sgp-atstuj3rtoptyui****
    Serversobject []Yes

    The backend servers that you want to modify. You can specify up to 40 servers in each call.

    ServerIdstringYes

    The backend server ID. You can specify at most 40 backend servers 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 this parameter to an IP address.
    		ecs-bp67acfmxazb4p****
    ServerTypestringYes

    The type of the backend server. Valid values:

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

    The IP address of the backend server. If the server group type is Ip, you must specify an IP address.

    Note You can specify at most 40 backend servers in each call.
    		192.168.6.6
    PortintegerYes

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

    Note This is parameter cannot be modified.
    		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 backend servers in each call.
    		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 signs (@), underscores (_), and hyphens (-).

    		test
    RegionIdstringNo

    The region ID of the NLB instance.

    You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou
    DryRunbooleanNo

    Specifies whether to perform 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 message 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 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

    Updates the configurations of backend servers in a server group.

    RequestIdstring

    The request ID.

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

    The server group ID.

    		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
    400IncorrectStatus.%sThe status of %s [%s] is incorrect.
    400Conflict.%sThe %s [%s] is conflict.
    400IllegalParam.%sThe param of %s is illegal.
    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-22The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 403 change
      delete Error Codes: 400
      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
      Error Codes 404 change
      delete Error Codes: 403
    2023-09-05The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      Error Codes 404 change
      delete Error Codes: 403
    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