Use UpdateLoadBalancerZones to modify load balancer zones - Server Load Balancer - Alibaba Cloud - Server Load Balancer

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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

nlb:UpdateLoadBalancerZones

update

*LoadBalancer

acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

None

Request parameters

Parameter	Type	Required	Description	Example
LoadBalancerId	string	Yes	The ID of the NLB instance.	nlb-83ckzc8d4xlp8o****
ZoneMappings	array<object>	Yes	The mappings between the zones and the vSwitches. You can specify up to 10 zones.
	object	No	The mapping between the zone and the vSwitch. You can specify up to 10 zones.
VSwitchId	string	Yes	The ID of the vSwitch in the zone. By default, each zone uses one vSwitch and one subnet.	vsw-bp1rmcrwg3erh1fh8****
ZoneId	string	Yes	The zone ID. You can call the DescribeZones operation to query the most recent zone list.	cn-hangzhou-a
PrivateIPv4Address	string	No	The private IP address.	192.168.36.16
AllocationId	string	No	The ID of the elastic IP address (EIP) or Anycast EIP.	eip-bp1aedxso6u80u0qf****
EipType	string	No	The type of the EIP. Valid values: Common: an EIP Anycast: an Anycast EIP Note For regions that support Anycast EIPs, see Limits.This parameter is required if AddressType is set to Internet.	Common
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: validates the request without performing the operation. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the validation, the corresponding error message is returned. If the request passes the validation, the `DryRunOperation` error code is returned. false (default): validates the request and performs the request. If the request passes the validation, an HTTP 2xx status code is returned and the operation is performed.	false
ClientToken	string	No	The client token used to ensure the idempotence of the request. You can use the client to generate the token. Ensure that the token is unique among different requests. Only ASCII characters are allowed. Note If you do not set this parameter, the value of RequestId is used.** The value of RequestId** is different for each request.	123e4567-e89b-12d3-a456-426655440000
RegionId	string	No	The ID of region where the NLB instance is deployed. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	response
RequestId	string	The request ID.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
JobId	string	The ID of the asynchronous task.	72dcd26b-f12d-4c27-b3af-18f6aed5****

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	ResourceInCreating.loadbalancer	The specified resource of loadbalancer is creating, please try again later.	The specified resource of loadbalancer is creating, please try again later.
400	OperationDenied.ProtectedPrivateIPv4AddressChanged	The operation is not allowed because of ProtectedPrivateIPv4AddressChanged.
400	OperationFailed.vSwitchNotSupportIpv6	The operation failed because of vSwitchNotSupportIpv6.
400	OperationDenied.%s	The operation is not allowed because of %s.
400	OperationDenied.ZoneVSwitchChanged	The operation is not allowed because of ZoneVSwitchChanged.	The existing zone does not allow changes to the virtual switch.
400	InvalidZones	The current zone list is illegal.	The Availability Zone used in Zone maping is illegal.
400	ResourceInConfiguring.loadbalancer	The specified resource of loadbalancer is being configured, please try again later.	The specified resource of loadbalancer is being configured, please try again later.
400	SystemBusy	System is busy, please try again later.
400	ResourceNotEnough.VSwitchIp	The specified resource of VSwitchIp is not enough.	The specified virtual switch (vSwitch) IP resources are insufficient.
403	UnauthorizedZone	The specified zone of %s is not authorized.
404	ResourceNotFound.loadBalancer	The specified resource of loadbalancer is not found.	The specified load balancer resource was not found. Please check the input parameters.
404	ResourceNotFound.VSwitch	The specified resource of vSwitch is not found.	The specified vSwitch resource was not found. Please check the input parameters.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.