Add or Remove GWLB Zones with UpdateLoadBalancerZones - Server Load Balancer - Alibaba Cloud - Server Load Balancer

Updates the active zones of a load balancing instance.

Operation description

Make sure that you fully understand the billing methods and pricing of the Gateway Load Balancer (GWLB) load balancing product before you invoke this operation.

UpdateLoadBalancerZones is an asynchronous operation. The system returns a request ID, but the active zone and active zone properties of the instance are not immediately modified. A change node is still running in the background. You can invoke GetLoadBalancerAttribute to query the update status of the Gateway Load Balancer (GWLB) load balancing instance:

If the Gateway Load Balancer (GWLB) load balancing instance is in the Configuring state, the instance is being updated.
If the Gateway Load Balancer (GWLB) load balancing instance is in the Active state, the instance is updated.

Important Each time you invoke this operation, make sure that you specify all active zone parameters for the Gateway Load Balancer (GWLB) load balancing instance, including the current active zones and the new active zones. If you do not specify a current active zone, the current active zone is deleted. You can invoke the GetLoadBalancerAttribute operation to query the current active zones of the instance.

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

gwlb:UpdateLoadBalancerZones

update

*LoadBalancer

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

*VSwitch

acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}

None

Request parameters

Parameter	Type	Required	Description	Example
LoadBalancerId	string	Yes	The ID of the Gateway Load Balancer (GWLB) load balancing instance.	gwlb-9njtjmqt7zfcqm****
ZoneMappings	array<object>	Yes	The list of zone and vSwitch mappings. You must specify at least one zone and can specify up to 20 zones. If the current region supports two or more zones, add two or more zones.
	object	No	The zone and vSwitch mapping object.
VSwitchId	string	Yes	The vSwitch that corresponds to the zone. Each zone can use only one vSwitch and one subnet.	vsw-bp1n75pbs77v5q6p3****
ZoneId	string	Yes	The active zone ID. You can invoke the DescribeZones operation of the Gateway Load Balancer (GWLB) load balancing service to obtain the active zone ID.	cn-hangzhou-h
DryRun	boolean	No	Specifies whether to only precheck the request. Valid values: true: The system prechecks the request without updating the instance zones. The system checks whether required parameters are specified, the request format is valid, and service limits are met. If the request fails the precheck, the corresponding error is returned. If the request passes the precheck, the `DryRunOperation` error code is returned. false (default): The system sends a normal request. If the request passes the precheck, the system returns an HTTP 2xx status code and performs the operation.	false
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 value. Make sure that the token is unique among different requests. The ClientToken parameter supports 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 of each API request is unique.	123e4567-e89b-12d3-a456-42665544****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	ED8905C2-A4F6-5E43-87B7-6A5DC8757146

Examples

Success response

JSON format

{
  "RequestId": "ED8905C2-A4F6-5E43-87B7-6A5DC8757146"
}

Error codes

HTTP status code	Error code	Error message	Description
400	OperationDenied.VSwitchChangeNotSupport	The operation is not allowed because of VSwitchChangeNotSupport.	Modifying the vSwitch is not allowed.
400	DuplicatedParam.VSwitchId	The param of VSwitchId is duplicated.	Duplicate vSwitchId parameter in list
400	DuplicatedParam.ZoneId	The param of ZoneId is duplicated.	Duplicate ZoneId parameter in list
400	IllegalParamSize.ZoneMappings	The param size of ZoneMappings is illegal.	Illegal number of ZoneMappings lists
400	IncorrectBusinessStatus.LoadBalancer	The business status of %s [%s] is incorrect.	Resource %s with business state %s does not support current operation
400	IncorrectStatus.LoadBalancer	The status of %s [%s] is incorrect.	Resource %s current state %s does not support operation
400	Mismatch.ZoneIdAndVSwitchId	The ZoneId and VSwitchId are mismatched.	The value of the ZoneId parameter does not match that of the vSwitchId
400	MissingParam.LoadBalancerId	The param of LoadBalancerId is missing.	Load balancing ID parameter missing
400	OperationDenied.VSwitchNotSupportIpv6	The operation is not allowed because of VSwitchNotSupportIpv6.	The operation is not allowed because IPv6 is not enabled for the vSwitch.
400	ResourceAlreadyAssociated.GwlbeAssociated	The specified resource of %s is already associated.	The specified resource %s is already associated
400	ResourceNotEnough.VSwitchIp	The specified resource of VSwitchIp is not enough.	Insufficient vSwitch IP resources
400	ResourceNotFound.LoadBalancer	The specified resource of %s is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.