MigrateToOtherZone-阿里云帮助中心

Use this API to move an RDS instance to a different availability zone.

Operation description

Supported engines

RDS MySQL
RDS PostgreSQL
RDS SQL Server

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

rds:MigrateToOtherZone

update

*DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

rds:ResourceTag

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. You can call the `DescribeDBInstances` operation to query the IDs of instances.	rm-uf6wjk5****
VPCId	string	No	The ID of the virtual private cloud (VPC). The VPC of the instance cannot be changed when the instance is migrated to another availability zone. This parameter is required if the instance resides in a VPC. If the instance runs SQL Server, you can change the VPC during the migration.	vpc-****
ZoneId	string	Yes	The ID of the destination availability zone. You can call the `DescribeRegions` operation to query the IDs of availability zones.	cn-hangzhou-b
EffectiveTime	string	No	The time when the migration takes effect. Valid values: Immediate: The migration takes effect immediately. This is the default value. MaintainTime: The migration takes effect during the maintenance window. For more information, see `ModifyDBInstanceMaintainTime`. ScheduleTime: The migration takes effect at a specified time. Note If you set this parameter to ScheduleTime, you must also specify the SwitchTime parameter.	Immediate
VSwitchId	string	No	The ID of the vSwitch. This parameter is required if the instance resides in a VPC. You can call the `DescribeVSwitches` operation to query available vSwitches. For an RDS instance that runs PostgreSQL or SQL Server, you can specify multiple vSwitch IDs for a multi-zone migration. Separate the IDs with commas (,) and make sure that the vSwitch IDs correspond to the availability zones.	vsw-uf6adz52c2p****
Category	string	No	The instance edition. Valid values: Basic: Basic Edition HighAvailability: High-availability Edition AlwaysOn: Cluster Edition for SQL Server cluster: Cluster Edition for MySQL Finance: Enterprise Edition (with three nodes)	HighAvailability
ZoneIdSlave1	string	No	The ID of the first secondary availability zone. Note This parameter is required for instances of all editions except Basic Edition.	cn-hangzhou-c
ZoneIdSlave2	string	No	The ID of the second secondary availability zone. Note This parameter is applicable only to instances that run Enterprise Edition (with three nodes).	cn-hangzhou-d
SwitchTime	string	No	The scheduled time to switch the instance over to the new availability zone. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note This parameter is required only when you set the EffectiveTime parameter to ScheduleTime.	2021-12-14T15:15:15Z
IsModifySpec	string	No	Specifies whether to modify the instance specifications during the migration. Valid values: true: Modify the specifications. If you set this parameter to true, you must specify at least one of the DBInstanceClass and DBInstanceStorage parameters. false: Do not modify the specifications. This is the default value. Note This parameter applies only to RDS for MySQL instances.	true
DBInstanceClass	string	No	The new instance type. You can change the instance type but not the storage type. If you set the IsModifySpec parameter to true, you must specify this parameter or DBInstanceStorage. For more information about instance types, see Primary ApsaraDB RDS for MySQL instance types.	mysql.x4.xlarge.2
DBInstanceStorage	integer	No	The new storage capacity of the instance. If you set the IsModifySpec parameter to true, you must specify this parameter or DBInstanceClass. Unit: GB. The value range of this parameter varies based on the instance type. For more information, see Primary ApsaraDB RDS for MySQL instance types.	500
IoAccelerationEnabled	string	No	Specifies whether to enable the Buffer Pool Extension (BPE) feature for the ESSD. Valid values: 1: enables BPE. 0: disables BPE. Note For more information about BPE, see Enable BPE.	0
DBInstanceStorageType	string	No	The storage type of the instance. Valid values: cloud_essd: enhanced SSD (ESSD) of performance level 1 (PL1). cloud_essd2: ESSD of PL2. cloud_essd3: ESSD of PL3. cloud_ssd: standard SSD.	cloud_essd
CustomExtraInfo	string	No

Response elements

Element	Type	Description	Example
	object	The response parameters.
DBInstanceId	string	The instance ID.	rm-uf6wjk5****
OrderId	integer	The order ID. This parameter is returned only for RDS for MySQL instances.	21334157599****
RequestId	string	The request ID.	65BDA532-28AF-4122-AA39-B382721EEE64

Examples

Success response

JSON format

{
  "DBInstanceId": "rm-uf6wjk5****",
  "OrderId": 0,
  "RequestId": "65BDA532-28AF-4122-AA39-B382721EEE64"
}

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.
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.	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.
400	InvalidTunnelId	Specified conn tunnel is not valid.
400	SSLNotSupport	The CharacterType of instance does not support SSL.	The character type of the instance does not support SSL.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	Your account available limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	Failed to call commodity service return.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.	Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	Hello customer, this area has been abolished.
400	Price.CommoditySys	Commodity system call exception.	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	No payment method has been specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	Your basic information is not complete, please complete your basic information before operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.	The current interface does not support.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	The DBInstanceId provided does not exist.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	The current instance type does not support the specified storage type.
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
400	KmsApiError	User secret key invalid.	The user key is invalid.
400	System.SaleValidateFailed	Sales expression validation system error.	A system error occurs when the sales expression is verified.
400	Abs.InvalidAccount.NotFound	account is not found.	The account does not exist.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	SQL command execution failed or timed out
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.	This operation is not supported by the instance type.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	The link address name is duplicate. Please reset the connection string.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	This operation is not supported for the database engine of the instance.
400	Pay.NoCreditCard	No credit cards.	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	The vpc network type instance does not support this operation.
400	UnsupportedClassCode	The specified DB instance class stops selling.	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.	Failed to query product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	The instance has been released, please verify and place an order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	The region is no longer supported.
400	UnSupportDbTypeReduceDiskSize	The current instance does not support scale-in.	The current instance does not support scale-in.
400	UnsupportedReduceDiskSize	Current Instance not support reduce disk size less than limit size.	The current instance does not support reducing the disk size to less than the limit size.
400	UnsupportExtendDisk.NotSupport	Specified DB instance is unsupport extend disk.	Disk expansion is not supported on the specified instance.
400	ClassicNetDisabled	The classic network address is currently disabled, and the instance cannot perform configuration changes.	The classic network address is currently disabled and the instance cannot perform configuration changes.
400	InvalidParamForXfs	Xfs instance must be single tenant standard instance.	Xfs instance must be single tenant standard instance.
400	InstanceHasLinkedServerInfo	The instance has linked server info, please delete linked server info first.	The current instance has a linked server. Please delete it before migrating to the Availability Zone.
500	ExternalFailure	The request processing has failed due to external service failure.	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	The service request failed. Please try again later or contact service personnel.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.	The request failed to be processed due to an RDS API failure.
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.
403	MigrateSlaveNotSupport	Current DB instance state does not support migrating slave, please switch the Primary/Secondary Instance first.	The status of the current instance does not support the migration of only the backup database. Forced migration will reduce the performance of accessing the database. Please perform an HA switch first.
403	CloudDiskEncryptionNotSupport	The encryption key is not allowed for general-purpose instance.	Universal instances do not support cloud disk encryption.
403	IncorrectMinorVersion	Current engine minor version does not support operations.	This operation is not supported for the current minor engine version.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	The instance has an unpaid order. Please pay first and try again.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	The scale-in target capacity cannot be less than the current storage space usage
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.	The user is not authorized to perform this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	OperationDenied.ZoneResource	There is no available zone for inventory.	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	The specified database instance type does not support this operation.
403	InstanceEngineType.NotSupport	The instance engine and type does not support operations.	The RDS MySQL instance engine and type do not support this operation. Check whether the instance kindcode and kernel minor version are too low and upgrade the kernel minor version.
403	UnsupportedByBlueGreenDeployment	Operation prohibited due to blue green deployment.	The operation is not allowed because a blue-green deployment exists.
403	CurrentRecoveryModelNotSupportThisAction	Current recovery model not supported this action.	The current recovery model does not support.
403	UnSupportNonXfsDiskSizeTooLarge	Non xfs disk types do not support upgrading to 60T or above.	Non-xfs disk types do not support upgrading to 60T or higher.
403	ShrinkCountReachedLimit	Current DB shrink count reached the limit.
403	IncorrectReadDBInstanceDisksize	Read instance disk size must be equal or higher than primary instance.	The disk size of the read-only instance must be equal to or greater than that of the primary instance.
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.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	The instance does not have permissions to access Key Management Service (KMS).
404	Request.NotFound	The requested resource is not available.	The requested resources are unavailable.
404	HostInfo.NotFound	The specified host info is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.