Creates a migration task to restore backup files from an Object Storage Service (OSS) bucket to an ApsaraDB RDS for SQL Server instance.
Operation description
Supported database engine
SQL Server
Limits
Data migration across Alibaba Cloud accounts is not supported. For example, backup files in an Object Storage Service (OSS) bucket within Alibaba Cloud Account A cannot be migrated to an ApsaraDB RDS for SQL Server instance within Alibaba Cloud Account B.
Note
You can migrate backup files from an OSS bucket within Alibaba Cloud Account A to an OSS bucket within Alibaba Cloud Account B. Make sure that the data in the OSS bucket and the RDS instance belong to the same Alibaba Cloud account. Then, you can call this operation to create a migration task. For more information, see Use Data Online Migration to migrate data between accounts.
References
Note
Before you call this operation, carefully read the following topic. Make sure that you fully understand the prerequisites, preparations, and impacts for calling this operation.
Migrate data from a self-managed SQL Server instance to an ApsaraDB RDS for SQL Server instance
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DBInstanceId | string | Yes | The instance ID. You can call the DescribeDBInstances operation to query the instance ID. | rm-uf6wjk****** |
| DBName | string | Yes | The name of the destination database. | testDB |
| BackupMode | string | Yes | The type of the migration task. Valid values:
| FULL |
| IsOnlineDB | string | Yes | Specifies whether to make the restored database data available for user access. Valid values:
Note
Set 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:
Default value: AsyncExecuteDBCheck (compatible with SQL Server 2008 R2) Note
This parameter is valid when IsOnlineDB is set to True.
| 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 (:):
Note
| 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. Note
This parameter is required for instances that run SQL Server 2008 R2.
| check_cdn_oss.sh www.xxxxxx.mobi |
| MigrateTaskId | string | No | The migration task ID.
Note
| None |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "866F5EB8-4650-4061-87F0-379F6F968BCE",
"DBName": "test02",
"BackupMode": "FULL",
"DBInstanceId": "rm-uf6wjk******",
"MigrateTaskId": "564******",
"TaskId": "545****"
}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 DB type does not support this operation. |
| 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. |
| 400 | BakFileSizeExceeded | Exceeding the allowed backup file size. | Backup file size exceeds allowed value. |
| 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 user center 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. | Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024. |
| 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 | 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. |
| 403 | InvalidInstanceState | The DB instance state does not support this operation. | The operation failed. The RDS instance is unavailable. |
| 403 | InvalidOssObjectPositions.Format | The specified params OssObjectPositions is not valid. | - |
| 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. | - |
| 404 | BakFilesNeeded | Backup file does not supply. | - |
| 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). |
| 500 | ExternalFailure | The request processing has failed due to external service failure. | The request processing has failed due to external service failure. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-05-29 | The Error code has changed | View Change Details |
| 2024-05-22 | The Error code has changed | View Change Details |
| 2023-03-28 | The Error code has changed | View Change Details |
| 2022-10-28 | The Error code has changed | View Change Details |