UpdateLoadBalancerZones-阿里云帮助中心

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

Operation description

The UpdateLoadBalancerZones operation is asynchronous. After a request is sent, the system returns a request ID even though the zone attributes of the ALB instance have not been modified. The modification task continues to run in the background. You can call GetLoadBalancerAttribute to query the modification status of the zone attributes of the ALB instance:

If the ALB instance is in the Configuring state, the zone attributes are being modified.
If the ALB instance is in the Active state, the zone attributes have been modified.

Note

Calling the UpdateLoadBalancerZones 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 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 RequestId of the API request as the ClientToken. The RequestId may be different 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. The system checks the request for potential issues, including missing parameter values, incorrect request format, and service limits. If the request fails the dry run, the corresponding error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): sends a normal request, passes the dry run, and returns an `HTTP_2xx` status code. The operation is then performed to modify the zone attributes of the Application Load Balancer (ALB) instance.	true
LoadBalancerId	string	Yes	The Application Load Balancer (ALB) instance ID.	alb-o9ulmq5hfn68jk****
ZoneMappings	array<object>	Yes	The mappings between zones and vSwitches. You can specify up to 10 zones. If the current region supports two or more zones, specify at least two zones. If specified, the previous zone configuration is replaced.
	object	No	The zone and vSwitch mapping structure. You can specify up to 10 zones. If the current region supports two or more zones, specify at least two zones. If specified, the previous zone configuration is replaced.
VSwitchId	string	Yes	The vSwitch that corresponds to the zone. Each zone uses one vSwitch and one subnet by default. You can specify up to 10 zones. If the current region supports two or more zones, specify at least two zones.	vsw-bp1rmcrwg3srh1fh8****
ZoneId	string	Yes	The zone name. You can call the DescribeZones operation to query the zones. You can specify up to 10 zones. If the current region supports two or more zones, specify at least two zones.	cn-hangzhou-a
EipType	string	No	The type of the public elastic IP address (EIP). Valid values: Common: elastic IP address (EIP). Anycast: Anycast elastic IP address (Anycast EIP). Note For the regions where ALB supports binding Anycast EIPs, see Limits.	Common
IntranetAddress	string	No	The IPv4 private IP address. Specify at least two zones and up to 10 zones.	192.168.10.1
RetainResourceType	array	No	The type of ALB-created resources to retain. When you remove a zone from an Internet-facing ALB instance, you can set this parameter to eip to retain the EIPs that are automatically created and associated by the ALB. Anycast EIPs cannot be retained. EIPs that you manually associated are automatically retained.
	string	No	The type of resource to retain. Set this parameter to eip, which indicates elastic IP addresses.	eip

Response elements

Element	Type	Description	Example
	object	The zone attributes.
JobId	string	The asynchronous task 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.	The current status of the instance does not support this operation.
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.	The operation is rejected because the zones have not changed.
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.