MigrateToOtherZone - ApsaraDB RDS - Alibaba Cloud Documentation Center

Migrates an instance across zones.

Operation Description

The prerequisites for this operation vary based on the database engine of the instance. For more information, see the following topics:

NoteThis operation allows you to migrate an instance across zones in the same region. This operation does not allow you to migrate an instance across zones in different regions. For example, you cannot migrate an instance from a zone in the China (Hangzhou) region to a zone in the China (Qingdao) region.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
rds:MigrateToOtherZone	WRITE	RDS acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The ID of the instance. You can call the DescribeDBInstances operation to query the ID of the instance.	rm-uf6wjk5xxxxxxxxxx
VPCId	string	No	The ID of the virtual private cloud (VPC) to which the instance belongs. Do not change the VPC of the instance when you migrate the instance across zones. This parameter must be specified when the instance resides in a VPC. If the instance runs SQL Server, you can change the VPC of the instance.	vpc-xxxxxxx
ZoneId	string	Yes	The ID of the destination zone. You can call the DescribeRegions operation to query the most recent zone list.	cn-hangzhou-b
EffectiveTime	string	No	The time when you want to migrate the instance. Valid values: Immediate: The instance is immediately migrated. This is the default value. MaintainTime: The instance is migrated during the maintenance window. For more information, see ModifyDBInstanceMaintainTime. ScheduleTime: The instance is migrated at the point in time that you specify. NoteIf you set this parameter to ScheduleTime, you must also specify SwitchTime.	Immediate
VSwitchId	string	No	The ID of the vSwitch. This parameter must be specified when the instance resides in a VPC. You can call the DescribeVSwitches operation to query the vSwitch ID. If the instance runs PostgreSQL or SQL Server and a secondary zone is specified for the instance, you can specify multiple vSwitch IDs, each of which corresponds to a zone. Separate the vSwitch IDs with commas (,).	vsw-uf6adz52c2pxxxxxxx
Category	string	No	The RDS edition of the instance. Valid values: Basic: RDS Basic Edition HighAvailability: RDS High-availability Edition AlwaysOn: RDS Cluster Edition Finance: RDS Enterprise Edition	HighAvailability
ZoneIdSlave1	string	No	The zone ID of the secondary instance. NoteIf the instance does not run RDS Basic Edition, you must specify this parameter.	cn-hangzhou-c
ZoneIdSlave2	string	No	The zone ID of the logger instance. NoteThis parameter is available only when the instance runs RDS Enterprise Edition.	cn-hangzhou-d
SwitchTime	string	No	The migration time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. NoteThis parameter is used with EffectiveTime. You must specify this parameter only when EffectiveTime is set to ScheduleTime.	2021-12-14T15:15:15Z
IsModifySpec	string	No	Specifies whether to change the specifications of the instance during the cross-zone migration. Valid values: true: You want to change the specifications of the instance during the cross-zone migration. If you set this parameter to true, you must specify at least one of DBInstanceClass and DBInstanceStorage. false (default): You do not want to change the specifications of the instance during the cross-zone migration. NoteThis parameter applies only to instances that run MySQL.	true
DBInstanceClass	string	No	The new instance type of the instance. You can change the instance type of the instance. You cannot change the storage type of the instance. If you set IsModifySpec to true, you must specify at least one of DBInstanceClass and DBInstanceStorage. For more information about instance types, see Primary ApsaraDB RDS for MySQL instance types.	mysql.x4.xlarge.2
DBInstanceStorage	long	No	The new storage capacity of the instance. If you set IsModifySpec to true, you must specify at least one of DBInstanceStorage and DBInstanceClass. Unit: GB. The available storage capacity range varies based on the instance type of the instance. For more information, see Primary ApsaraDB RDS for MySQL instance types.	500

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	65BDA532-28AF-4122-AA39-B382721EEE64
DBInstanceId	string	The ID of the instance.	rm-uf6wjk5xxxxxxxxxx
OrderId	long	The ID of the order. This parameter is returned only when the instance runs MySQL.	213341575990728

Examples

Sample success responses

JSONformat

{
  "RequestId": "65BDA532-28AF-4122-AA39-B382721EEE64",
  "DBInstanceId": "rm-uf6wjk5xxxxxxxxxx",
  "OrderId": 213341575990728
}

Error codes

HTTP status code	Error code	Error message	Description
400	RenewChange.Exist	The Current InstanceId existed renewChange order in RDS.	A specification change task is in progress. Try again after the task is completed.
400	InvalidInstanceCommodityCode.NotFound	Parse commodityCode from lx and instance fail.	-
400	InvalidMigrateModifyClassOrStorage	Specified parameter DBInstanceClass or Storage is invalid.	-
400	EngineNotSupported	Engine specified cannot be supported the operation.	The operation failed. This operation is not supported for the database engine version of the RDS instance. Update the minor engine version of the RDS instance.
400	IncorrectDBInstanceLockMode.ValueNotSupported	The Current DB instance lock mode does not support this operation.	The operation failed. The RDS instance is locked.
400	InvalidZoneId.NotNull	The parameter ZoneId must not be null or auto	ZoneId must not be null or auto.
400	InvalidZoneId.NotEqual	The parameter ZoneId is the same as the previous one	The two zones are the same.
400	InvalidDispenseMode.Format	The specified dispense mode is not valid.	-
400	IncorrectDBInstanceType	Current DB instance type does not support this operation.	The operation failed. The RDS instance is not in a ready state.
400	ZoneId.NotMatchWithCategory	The Number of ZoneId specified does not match with category	-
400	InvalidDefaultVSwitch.NotFound	The specified default virtual switch is not found in specified VPC.	-
400	InsufficientResourceCapacityCheck	There is insufficient capacity available for the requested instance with precheck.	The available capacity of the instance to be prechecked is insufficient.
400	UnsupportedReadOrBakReadState	Current DB instance has read or bak read instance running in unsupported states	-
400	IncorrectDBInstanceState	Current DB instance state does not support this operation.	-
400	MirrorInsExists	Specified DB instance mirror ins already existed.	-
400	SSLInstanceNotSupportThisOperation	The instance opened SSL, upgrade is not this operation	This operation is not supported for instances that have SSL enabled.
400	BYOLInstanceNotSupportThisOperation	The BYOL instance is not supported this operation	This operation is not supported for instances that are created from BYOL images.
400	BYOKInstanceNotSupportThisOperation	The BYOK instance is not supported this operation	This operation is not supported for instances that have disk encryption enabled.
400	ADInstanceNotSupportThisOperation	The AD instance is not supported this operation	This operation is not supported for instances that have been joined to an AD domain.
400	TDEInstanceNotSupportThisOperation	The instance opened TDE, this operation is not supported	This operation is not supported for instances that have TDE enabled.
400	InstanceIsSnapshotBackupNotSupportThisOperation	The instance backup method is snapshot backup, this operation is not supported	This operation is not supported for instances that have snapshot backup enabled.
400	InstanceHasReadOnlyInstanceNotSupportThisOperation	The instance has read-only instance or is read-only instance, this operation is not supported	This operation is not supported because this instance has read-only instances or it is a read-only instance.
400	VswitchIpExhausted	No available ip in the specified vswitch.	No available IP address exists in the specified vSwitch.
400	OperationDenied.MasterDBInstanceState	The operation is not permitted due to status of master instance.	The operation failed. The configuration of the read-only instance is being changed. In this case, you cannot perform this operation on the primary instance. Wait until the configuration of the read-only instance is changed and try again.
400	InvalidShareInstance.NotSupport	The share dbInstance is not support.	This operation is not supported for shared instances.
400	InvalidZoneIdSlave1.Missing	The parameter ZoneIdSlave1 must be specified.	You must specify the secondary zone ID.
400	MigrateAlreadyExistsFault	The rds instance already has a given vpc migrate task.	The RDS instance already contains a VPC migration task.
400	InvalidInstanceKind.NotSupport	The instance kind does not support this operation.	The instance type does not support this operation.
400	MissingCategory	The instance is missing a category parameter.	-
400	InvalidInstanceNodeType.NotFound	The specified NodeType is not found.	-
400	EngineVersionNotSupported	EngineVersion specified cannot be replicate with the source DB Instance.	Instance cloning is not supported for the database engine version of the current instance.
400	CommodityCodeNotFound	CommodityCodeNotFound	The specified parameter CommodityCode is invalid. Please check again.
403	OperationDenied.OutofUsage	The resource is out of usage.	The available resources in the zone are insufficient. Specify a different zone.
403	IncorrectEffectiveTime	The specified EffectiveTime params is not valid.	The value of the EffectiveTime parameter is invalid.
403	InvalidTempInstance.NotSupport	The temp db Instance is not support.	The instance is locked.
403	OperationDenied.LockMode	The operation is not permitted due to instance being locked.	The operation failed. The RDS instance is locked. Check whether the RDS instance has expired or its storage capacity is exhausted. If the RDS instance has expired, renew the RDS instance. If the storage capacity is exhausted, expand the storage capacity of the RDS instance.
403	ClassicNetworkType.NotSupport	The Classic instance network create is not support.	The current instance cannot be deployed in the classic network. Change the network type to VPC.
403	InstanceNetworkTypeNotFoundFault	The specified DBInstanceNetworkType is not found.	The network type failed the verification check. The network type cannot be found.
403	ProprietaryCloud.NotSupported	The proprietary cloud not supported.	-
403	MigrateAlreadyReadWriteSplitExistsFault	The rds instance already has a given vpc migrate task.	A task of migrating data to the specified VPC already exists.
403	InvalidRegionAvzNotFound	Specified user does not find the region and avz.	-
403	ZoneIdNotSupported	The zone ID is not supported.	The operation failed. The operation is not supported in the region.
403	InvalidVpcInfo.NotFound	Specified VPC info does not exist.	The specified VPC does not exist.
403	InvalidMultiparamZoneInfoList	Zoneinfo list is invaild.	-
404	InvalidDBInstanceName.NotFound	The database instance does not exist.	The name of the RDS instance cannot be found. Check the name of the RDS instance.
404	IncorrectVswitchId	The specified parameter VSwitchId is not valid.	The vSwitch ID is invalid.

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-03-31