MigrateDBInstance - ApsaraDB RDS - Alibaba Cloud Documentation Center

Migrates an instance across hosts in a dedicated cluster.

Operation description

Dedicated clusters allow you to manage a number of instances at a time. You can create multiple dedicated clusters in a single region. Each dedicated cluster consists of multiple hosts. You can create multiple instances on each host. For more information, see What is ApsaraDB MyBase?

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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:MigrateDBInstance	update	DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
DedicatedHostGroupId	string	Yes	The dedicated cluster ID. You can call the DescribeDedicatedHostGroups operation to query the dedicated cluster ID.	dhg-4n******
DBInstanceId	string	Yes	The ID of the instance.	rm-uf6wjk5******
TargetDedicatedHostIdForMaster	string	Yes	The ID of the host to which you want to migrate the primary instance. You can call the DescribeDedicatedHosts operation to query the host ID.	i-bp******
TargetDedicatedHostIdForSlave	string	Yes	The ID of the host to which you want to migrate the secondary instance. You can call the DescribeDedicatedHosts operation to query the host ID.	i-bp******
EffectiveTime	string	No	The time when you want the system to start the migration. Valid values: Immediately: The system immediately starts the migration. This is the default value. MaintainTime: The system starts the migration during the specified maintenance window. Specified: The system starts the migration at the specified point in time.	MaintainTime
SpecifiedTime	string	No	The point in time when you want the system to start the migration. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note This parameter must be specified when you set EffectiveTime to Specified.	2019-10-21T10:00:00Z
ZoneIdForLog	string	No	The zone ID of the logger instance.	cn-hangzhou-i
ZoneIdForFollower	string	No	The zone ID of the secondary node.	cn-hangzhou-h

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	498AE8CA-8C81-4A01-AF37-2B902014ED30
TaskId	integer	The task ID.	10824****
MigrationId	integer	The serial number of the task in the migration task queue. When the serial number becomes 0, the system starts the migration.	224****

Examples

Sample success responses

JSONformat

{
  "RequestId": "498AE8CA-8C81-4A01-AF37-2B902014ED30",
  "TaskId": 0,
  "MigrationId": 0
}

Error codes

HTTP status code	Error code	Error message	Description
400	GeneralIns.Creating	The general instance is creating.	An RDS instance is in production. Please wait.
400	GeneralIns.Maintaining	The general instance is maintaining.	An RDS instance is being migrated or maintained. Please wait.
400	GeneralIns.Switching	The general instance is Switching.	A switchover for high availability is in progress. Please wait.
400	InvalidTargetDedicatedHostId.NotFound	The target dedicated host ID is invalid.	The host ID is invalid. Check the host ID and make sure that the host is available.
400	InvalidMasterHostName	The specified master host zoneId is different from the master zoneId.	The zone ID of the host is different from the ID of the primary zone.
400	InvalidDBInstanceName.NotFound	The specified DB instance name does not exist.	The instance name does not exist.
400	InvalidPrimaryCustinsStatus	Primary DBInstance status is not Active.	The operation failed. The operation can be performed only when the primary RDS instance to which the read-only RDS instance is attached is running.
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	RegionEndTimeDissolvedIndia	Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.	Hello customer, this area has been abolished.
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.	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
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.	-
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	BasicInfoUncompleted	Your information is incomplete, Complete your information before the operation.	-
400	System.SaleValidateFailed	Sales expression validation system error.	A system error occurs when the sales expression is verified.
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.
403	OperationDenied.PrimaryDBInstanceStatus	The operation is not permitted due to status of primary instance.	The operation failed. The RDS instance is deployed in a dedicated cluster and is not running.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	The instance has an unpaid order. Please pay first and try again.
404	InsufficientResourceCapacity	No host is available for the requested instance.	The specified zone does not have sufficient resources.
404	InvalidParam	The specified parameter is invalid.	-
404	InvalidDBInstance.NotFound	The specified instance does not exist or is not supported.	The RDS instance cannot be found. Check the ID or name of the RDS instance.
404	AllocateResourceFailed	Failed to allocate resources. Please check the zone and the host you selected.	Failed to obtain the requested resources. Check whether the zone and the host can provide sufficient resources for the instance type that you specify.

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

Change history

Change time	Summary of changes	Operation

No change history