All Products
Search

This Product

    Server Load Balancer:UpdateLoadBalancerZones

    Document Center

    Server Load Balancer:UpdateLoadBalancerZones

    Last Updated:Mar 13, 2024

    Modifies the zones and zone attributes of a Network Load Balancer (NLB) instance.

    Operation description

    When you call this operation, make sure that you specify all the zones of the NLB instance, including the existing zones and new zones. If you do not specify the existing zones, the existing zones are removed.

    Prerequisites

    • An NLB instance is created. For more information, see CreateLoadBalancer .

    • You can call the GetLoadBalancerAttribute operation to query the zones and zone attributes of an NLB instance.

    • 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 the GetJobStatus operation query to query the status of a task:

      • If the task is in the Succeeded state, the zones and zone attributes are modified.
      • If the task is in the Processing state, the zones and zone attributes are being modified. In this case, you can perform only query operations.

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

    Request parameters

    ParameterTypeRequiredDescriptionExample
    LoadBalancerIdstringYes

    The NLB instance ID.

    		nlb-83ckzc8d4xlp8o****
    ZoneMappingsobject []Yes

    The mappings between zones and vSwitches. You can specify at most 10 zones.

    VSwitchIdstringYes

    The ID of the vSwitch in the zone. By default, each zone uses one vSwitch and one subnet.

    		vsw-bp1rmcrwg3erh1fh8****
    ZoneIdstringYes

    The zone ID. You can call the DescribeZones operation to query the most recent zone list.

    		cn-hangzhou-a
    PrivateIPv4AddressstringNo

    The private IP addresses.

    		192.168.36.16
    AllocationIdstringNo

    The ID of the elastic IP address (EIP) or Anycast EIP.

    		eip-bp1aedxso6u80u0qf****
    EipTypestringNo

    The type of the EIP. Valid values:

    • Common
    • Anycast
    Note Anycast EIPs are supported only by NLB instances in the China (Hong Kong) region. This parameter is required when AddressType is set to Internet.
    		Common
    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: sends the request. If the request passes the check, an HTTP 2xx status code is returned and the operation is performed. This is the default value.
    		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
    RegionIdstringNo

    The region ID of the NLB instance.

    You can call the DescribeRegions operation to obtain the region ID.

    		cn-hangzhou

    Response parameters

    ParameterTypeDescriptionExample
    object

    response

    RequestIdstring

    The request ID.

    		CEF72CEB-54B6-4AE8-B225-F876FF7BA984
    JobIdstring

    The ID of the asynchronous task.

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

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    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 400 change
      delete Error Codes: 403
      delete Error Codes: 404
    2023-12-18The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      Error Codes 404 change
      Added Error Codes: 403
    2023-10-30The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      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
      Added Error Codes: 404
    2023-09-05The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    2023-08-22The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Added Error Codes: 400