MigrateDBInstance - PolarDB - Alibaba Cloud Documentation Center

Migrates an instance from one zone to another.

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

polardbx:MigrateDBInstance

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance.	cn-hangzhou
SwitchMode	string	No	The switch mode. Valid values: 0: Immediate switchover. 1: Switchover within the O&M window.	0
DBInstanceName	string	Yes	The instance ID.	pxc-xxx
TopologyType	string	Yes	The topology type. Valid values: 3azones: Three-zone deployment. 1azone: Single-zone deployment.	3azones
PrimaryZoneId	string	Yes	The zone ID of the primary zone for a multi-zone instance. This parameter is required if you want to create a multi-zone instance.	cn-zhangjiakou-b
SecondaryZoneId	string	No	The secondary zone ID. Note This parameter cannot be the same as the ZoneId property.	cn-beijing-l
TertiaryZoneId	string	No	The third active zone.	cn-beijing-h
VpcId	string	No	The ID of the VPC where the access endpoint resides.	vpc-****
VswitchId	string	No	The vSwitch ID. This parameter is required when you create a DRDS instance of the VPC network type.	vsw-****

Response elements

Element	Type	Description	Example
	object	MigrateDBInstanceResponse
Success	boolean	Indicates whether the request is successful.	true
Message	string	The returned message. If the request is successful, "success" is returned. If the request fails, the corresponding error code is returned.	*****
RequestId	string	The request ID.	FEA5DC20-6D8A-5979-97AA-FC57546ADC20

Examples

Success response

JSON format

{
  "Success": true,
  "Message": "*****",
  "RequestId": "FEA5DC20-6D8A-5979-97AA-FC57546ADC20"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.