All Products
Search

This Product

    Server Load Balancer:UpdateLoadBalancerZones

    Document Center

    Server Load Balancer:UpdateLoadBalancerZones

    Last Updated:Mar 01, 2024

    Modifies the zones of an Application Load Balancer (ALB) instance.

    Operation description

    UpdateLoadBalancerZones is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call GetLoadBalancerAttribute to query the status of the task.

    • If an ALB instance is in the Configuring state, the zones are being modified.
    • If an ALB instance is in the Active state, the zones are modified.
    Note You may be charged after you call UpdateLoadBalancerZones.

    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:UpdateLoadBalancerZonesWrite
    • LoadBalancer
      acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    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.
    		5A2CFF0E-5718-45B5-9D4D-70B3FF3898
    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 message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
    • false (default): performs a dry run and sends the request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
    		true
    LoadBalancerIdstringYes

    The ID of the ALB instance.

    		lb-bp1b6c719dfa08ex****
    ZoneMappingsobject []Yes

    The zones and the vSwitches. You must specify at least two zones. The specified zones overwrite the existing configurations.

    VSwitchIdstringYes

    The ID of the vSwitch in the zone. By default, you can specify only one vSwitch (subnet) for each zone of an ALB instance. You can specify up to 10 zone IDs.

    		vsw-bp1rmcrwg3erh1fh8****
    ZoneIdstringYes

    The name of the zone. You can call the DescribeZones operation to query the zones. You can specify up to 10 zone IDs.

    		cn-hangzhou-a

    Response parameters

    ParameterTypeDescriptionExample
    object

    The attributes that are modified.

    JobIdstring

    The ID of the asynchronous task.

    		72dcd26b-f12d-4c27-b3af-18f6aed5****
    RequestIdstring

    The request ID.

    		CEF72CEB-54B6-4AE8-B225-F876FF7BA984

    Examples

    Sample success responses

    JSONformat

    {
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400IncorrectStatus.LoadBalancerThe status of %s [%s] is incorrect.The status of %s [%s] is incorrect.
    400IncorrectBusinessStatus.LoadBalancerThe business status of %s [%s]  is incorrect.The business status of %s [%s]  is incorrect.
    400IncorrectBusinessStatus.EipThe business status of %s [%s]  is incorrect.The business status of %s [%s]  is incorrect.
    400OperationDenied.ZoneVSwitchChangedThe operation is not allowed because of %s.The operation is not allowed because of %s.
    400OperationDenied.ZoneMappingsNotChangedThe operation is not allowed because of %s.The operation is not allowed because of %s.
    400ResourceNotEnough.VSwitchIpThe specified resource %s is not enough.The specified resource %s is not enough.
    400Mismatch.ZoneIdAndVSwitchIdThe %s and %s are mismatched.The %s and %s are mismatched.
    404ResourceNotFound.LoadBalancerThe specified resource %s is not found.The specified resource %s is not found.
    404ResourceNotFound.VSwitchThe 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
    2023-10-30The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 404