All Products
Search

This Product

    Server Load Balancer:UpdateServerGroupServersAttribute

    Document Center

    Server Load Balancer:UpdateServerGroupServersAttribute

    Last Updated:Oct 12, 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

    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:UpdateServerGroupServersAttributeupdate
    • ServerGroup
      acs:nlb:{#regionId}:{#accountId}:servergroup/{#ServerGroupId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ServerGroupIdstringYes

    The server group ID.

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

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

    ServerobjectYes

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

    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.
    		ecs-bp67acfmxazb4p****
    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
    ServerIpstringNo

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

    		192.168.6.6
    PortintegerYes

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

    Note This parameter cannot be modified.
    		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 (-).

    		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 messageDescription
    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.
    400Conflict.LockThe Lock [%s] is conflict.The specific resource is conflict.
    400IllegalParam.%sThe param of %s is illegal.-
    400MissingParam.%sThe parameter of %s is missing.-
    403Forbidden.%sAuthentication is failed for %s.-
    403Forbidden.NoPermissionAuthentication is failed for NoPermission.Authentication is failed for NoPermission.
    404ResourceNotFound.BackendServerThe specified resource of BackendServer is not found.The specified backend server resource was not found. Please check the input parameters.
    404ResourceNotFound.serverGroupThe specified resource of serverGroup is not found.The specified resource of serverGroup is not found. Please check the input parameters.

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

    Change history

    Change timeSummary of changesOperation
    2024-01-22The Error code has changedView Change Details
    2023-09-26The 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