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

Operation description

Before you call this operation, make sure that you understand the billing method and pricing of GWLB.

UpdateLoadBalancerZones is an asynchronous operation. After you call this operation, the system returns a request ID, but the zones and zone attributes of the GWLB instance are not yet modified. The modification task runs in the background. You can call GetLoadBalancerAttribute to query the update status of the GWLB instance:

If the GWLB instance is in the Configuring state, the zones are being updated.
If the GWLB instance is in the Active state, the zones are updated.

Important When you call this operation, you must pass in all zone parameters for the GWLB instance, including existing and new zones. If you omit existing zone parameters, those zones are removed. You can call GetLoadBalancerAttribute to query the current 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 GWLB instance ID.	gwlb-9njtjmqt7zfcqm****
ZoneMappings	array<object>	Yes	The zone-to-vSwitch mappings. You must specify at least one zone and can specify up to 20 zones. If the region supports two or more zones, we recommend that you specify at least two zones.
	object	No
VSwitchId	string	Yes	The ID of the vSwitch in the zone. You can specify only one vSwitch (subnet) in each zone of a GWLB instance.	vsw-bp1n75pbs77v5q6p3****
ZoneId	string	Yes	The zone ID. You can call the DescribeZones operation to query the most recent zone list.	cn-hangzhou-h
DryRun	boolean	No	Specifies whether to perform only a dry run without executing the 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 code is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.	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, but you must ensure that the token is unique among different requests. The client 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-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.