CreateMigrateTask - ApsaraDB RDS - Alibaba Cloud Documentation Center

Creates a migration task to restore backup files from an Object Storage Service (OSS) bucket to an ApsaraDB RDS for SQL Server instance.

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:CreateMigrateTask	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.	rm-uf6wjk5xxxxxxx
DBName	string	Yes	The name of the destination database.	testDB
BackupMode	string	Yes	The type of the migration task. Valid values: FULL: The migration task migrates full backup files. UPDF: The migration task migrates incremental or log backup files.	FULL
IsOnlineDB	string	Yes	Specifies whether to make the restored database data available for user access. Valid values: True False NoteSet the value to True for instances that run SQL Server 2008 R2.	True
CheckDBMode	string	No	The consistency check method for the database. Valid values: SyncExecuteDBCheck: synchronous database check AsyncExecuteDBCheck: asynchronous database check Default value: AsyncExecuteDBCheck (compatible with SQL Server 2008 R2). NoteWhen you set IsOnlineDB to True, the value of this parameter is valid.	AsyncExecuteDBCheck
OssObjectPositions	string	No	The information about the backup file in the OSS bucket. The values consist of three parts that are separated by colons (:): OSS endpoint: oss-ap-southeast-1.aliyuncs.com. Name of the OSS bucket: rdsmssqlsingapore. Key of the backup file in the OSS bucket: autotest_2008R2_TestMigration_FULL.bak. Note This parameter is optional for instances that run SQL Server 2008 R2. This parameter is required for instances that run a database engine version later than SQL Server 2008 R2.	oss-ap-southeast-1.aliyuncs.com:rdsmssqlsingapore:autotest_2008R2_TestMigration_FULL.bak
OSSUrls	string	No	The shared URL of the backup file in the OSS bucket. The URL must be encoded. If you specify multiple URLs, separate them with vertical bars (\|) and then encode them. NoteThis parameter is required for instances that run SQL Server 2008 R2.	check_cdn_oss.sh www.xxxxxx.mobi
MigrateTaskId	string	No	The ID of the migration task. If you set BackupMode to FULL, the value of this parameter is empty. The full backup mode is compatible with instance that runs SQL Server 2008 R2. If you set BackupMode to UPDF, the value of this parameter is the ID of the required full migration task. Note If you set IsOnlineDB to True, the value of BackupMode must be FULL. If you set IsOnlineDB to False, the value of BackupMode must be UPDF.	None

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	866F5EB8-4650-4061-87F0-379F6F968BCE
DBName	string	The name of the database.	test02
BackupMode	string	The type of the migration task. Valid values: FULL: The migration task migrates full backup files. UPDF: The migration task migrates incremental or log backup files.	FULL
DBInstanceId	string	The ID of the instance.	rm-uf6wjk5xxxxx
MigrateTaskId	string	The ID of the migration task.	564563256
TaskId	string	The ID of the task.	5451225

Examples

Sample success responses

JSONformat

{
  "RequestId": "866F5EB8-4650-4061-87F0-379F6F968BCE",
  "DBName": "test02",
  "BackupMode": "FULL",
  "DBInstanceId": "rm-uf6wjk5xxxxx",
  "MigrateTaskId": "564563256",
  "TaskId": "5451225"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidFile	The operation does not support this kind of file	The operation failed. The format of the file is not supported.
400	InvalidInstanceType	The DB instance type does not support this operation.	The operation failed. The operation is not supported for the instance type of the RDS instance.
400	InvalidInstanceLockMode	The DB instance lock mode does not support this operation.	This operation is not supported for the lock mode of the RDS instance.
400	InvalidDBName	The instance does not have the specified DB name.	The destination database is not found. Check the name and status of the destination database. Otherwise, select a different database.
400	InvalidDBType	The DB type does not support this operation.	The operation failed. The database is not in a ready state.
400	InvalidDBState	The DB state does not support this operation.	The operation failed. The database is not in a ready state.
400	ExceedUploadTime	Exceeding the daily upload times of this DB.	The number of downloads on the day exceeds the maximum number of downloads that are allowed per day.
400	InvalidOSSURL	The Specified OSS URL is not valid	The endpoint of the OSS bucket is incorrect.
400	ExceedDiskSize	The file size exceeding the disk size	The size of the file exceeds the available storage space. Check the available storage space and try again.
400	EntityNotExist.Role	The role not exists	-
400	DatabaseMustOnline	Database must be taken online when task type is 0 or 1.	The database must be connected if the task type is 0 or 1.
400	InvalideStatus	Parent migrate task status is invalid.	The parent migration task is abnormal.
400	InvalidOssObjectStorageClassType	The specified OSS bucket storage type is invalid.	The storage class of the OSS bucket that stores the file 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	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.
403	InvalidInstanceState	The DB instance state does not support this operation.	The operation failed. The RDS instance is unavailable.
404	BakFilesNeeded	Backup file does not supply.	-

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

Change history

Change time

Summary of changes

Operation

2023-03-28

The error codes of the API operation change.

Change item	Change content
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
	delete Error Codes: 403
	Added Error Codes: 404

2022-10-28

The error codes of the API operation change.

Change item	Change content
Error Codes	The error codes of the API operation change.
	Error Codes 400 change
	delete Error Codes: 403