Use CancelShiftLoadBalancerZones to add a zone to the DNS record - Server Load Balancer - Alibaba Cloud - Server Load Balancer

Operation description

Before you call this operation, the zone of the Network Load Balancer (NLB) instance is removed from the DNS record by using the console or calling the StartShiftLoadBalancerZones API operation.

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:CancelShiftLoadBalancerZones

update

*LoadBalancer

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

None

Request parameters

Parameter	Type	Required	Description	Example
ZoneMappings	array<object>	Yes	The mapping between the zone and the vSwitch. Note You can specify only one zone ID in each call.
	object	No	The mapping between the zone and the vSwitch. Note You can specify only one zone ID in each call.
VSwitchId	string	Yes	The ID of the vSwitch in the zone. By default, each zone uses one vSwitch and one subnet.	vsw-sersdf****
ZoneId	string	Yes	The zone ID of the NLB instance. Note You can specify only one zone ID in each call. You can call the DescribeZones operation to query the most recent zone list.	cn-hangzhou-a
LoadBalancerId	string	Yes	The ID of the NLB instance.	nlb-83ckzc8d4xlp8o****
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 operation. If the request passes the validation, a 2xx HTTP status code is returned and the operation is performed.	true
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 the 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	RpcResponse
RequestId	string	The request ID.	54B48E3D-DF70-471B-AA93-08E683A1B45

Examples

Success response

JSON format

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectStatus.ZoneId	The zoneId status of eni [%s] is incorrect.	The zone status of the ENI cannot be operated. Wait for the preceding operation to complete.
403	Forbidden.%s	Authentication is failed for %s.
403	Forbidden.NoPermission	Authentication is failed for NoPermission.	Authentication is failed for NoPermission.
404	ResourceNotFound.loadBalancer	The specified resource of loadbalancer is not found.	The specified load balancer 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.