UpdateLoadBalancerZones-阿里云帮助中心

Modifies the availability zones of an ALB instance.

Operation description

UpdateLoadBalancerZones is an asynchronous API. After you send a request, the system returns a request ID but does not immediately modify the availability zones. The modification runs in the background. Call the GetLoadBalancerAttribute operation to query the modification status:

If the ALB instance is in the Configuring state, the modification is in progress.
If the ALB instance is in the Active state, the modification is complete.

Note

Calling this operation may incur fees.

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

alb:UpdateLoadBalancerZones

update

*LoadBalancer

acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token used to ensure the idempotence of the request. Generate a unique token from your client for each request. The `ClientToken` parameter can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the request's RequestId as the ClientToken. The RequestId differs for each API request.	5A2CFF0E-5718-45B5-9D4D-70B3FF3898
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run to check for potential issues, including missing parameters, incorrect formatting, and service limits. If the request fails the dry run, the system returns an error message. If the request passes the dry run, the system returns the `DryRunOperation` error code. false (default): sends the request. If the request passes the check, the system returns an HTTP `2xx` status code and performs the operation.	true
LoadBalancerId	string	Yes	The ID of the ALB instance.	alb-o9ulmq5hfn68jk****
ZoneMappings	array<object>	Yes	The mappings between availability zones and VSwitches. You can specify up to 10 availability zones. If the current region supports two or more availability zones, you must specify at least two. Specifying this parameter overwrites the existing availability zone configuration.
	object	No	The mapping between an availability zone and a VSwitch.
VSwitchId	string	Yes	The ID of the VSwitch in the availability zone. Each availability zone uses one VSwitch and one subnet by default.	vsw-bp1rmcrwg3srh1fh8****
ZoneId	string	Yes	The ID of the availability zone. You can call the DescribeZones operation to query the IDs of available zones.	cn-hangzhou-a
EipType	string	No	The type of the EIP. Valid values: Common: an EIP. Anycast: an Anycast EIP. Note For a list of regions that support binding an Anycast EIP to an ALB instance, see Usage limits.	Common
IntranetAddress	string	No	The private IPv4 address.	192.168.10.1

Response elements

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

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectStatus.LoadBalancer	The status of %s [%s] is incorrect.
400	IncorrectBusinessStatus.LoadBalancer	The business status of %s [%s] is incorrect.	The business status of %s [%s] is incorrect.
400	IncorrectBusinessStatus.Eip	The business status of %s [%s] is incorrect.	The business status of %s [%s] is incorrect.
400	OperationDenied.ZoneVSwitchChanged	The operation is not allowed because of %s.	The operation is not allowed because of %s.
400	OperationDenied.ZoneMappingsNotChanged	The operation is not allowed because of %s.
400	ResourceNotEnough.VSwitchIp	The specified resource %s is not enough.	The specified resource %s is not enough.
400	Mismatch.ZoneIdAndVSwitchId	The %s and %s are mismatched.	The %s and %s are mismatched.
404	ResourceNotFound.LoadBalancer	The specified resource %s is not found.	The specified resource %s is not found.
404	ResourceNotFound.VSwitch	The specified resource %s is not found.	The specified resource %s is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.