All Products
Search

This Product

    ApsaraDB RDS:CreateMigrateTask

    Document Center

    ApsaraDB RDS:CreateMigrateTask

    Last Updated:Apr 17, 2024

    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

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

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    rds:CreateMigrateTaskWRITE
    • DBInstance
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceIdstringYes

    The instance ID. You can call the DescribeDBInstances operation to query the instance ID.

    		rm-uf6wjk******
    DBNamestringYes

    The name of the destination database.

    		testDB
    BackupModestringYes

    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
    IsOnlineDBstringYes

    Specifies whether to make the restored database data available for user access. Valid values:

    • True
    • False
    Note Set the value to True for instances that run SQL Server 2008 R2.
    		True
    CheckDBModestringNo

    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).

    Note This parameter is valid when IsOnlineDB is set to True.
    		AsyncExecuteDBCheck
    OssObjectPositionsstringNo

    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 major engine version later than SQL Server 2008 R2.
    •
    		oss-ap-southeast-1.aliyuncs.com:rdsmssqlsingapore:autotest_2008R2_TestMigration_FULL.bak
    OSSUrlsstringNo

    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
    MigrateTaskIdstringNo

    The migration task ID.

    • 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

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The ID of the request.

    		866F5EB8-4650-4061-87F0-379F6F968BCE
    DBNamestring

    The name of the database.

    		test02
    BackupModestring

    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
    DBInstanceIdstring

    The instance ID.

    		rm-uf6wjk******
    MigrateTaskIdstring

    The ID of the migration task.

    		564******
    TaskIdstring

    The task ID.

    		545****

    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 codeError codeError messageDescription
    400InvalidFileThe operation does not support this kind of fileThe operation failed. The format of the file is not supported.
    400InvalidInstanceTypeThe DB instance type does not support this operation.The operation failed. The operation is not supported for the instance type of the RDS instance.
    400InvalidInstanceLockModeThe DB instance lock mode does not support this operation.This operation is not supported for the lock mode of the RDS instance.
    400InvalidDBNameThe 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.
    400InvalidDBTypeThe DB type does not support this operation.The operation failed. The database is not in a ready state.
    400InvalidDBStateThe DB state does not support this operation.The operation failed. The database is not in a ready state.
    400ExceedUploadTimeExceeding 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.
    400InvalidOSSURLThe Specified OSS URL is not validThe endpoint of the OSS bucket is incorrect.
    400ExceedDiskSizeThe file size exceeding the disk sizeThe size of the file exceeds the available storage space. Check the available storage space and try again.
    400EntityNotExist.RoleThe role not exists-
    400DatabaseMustOnlineDatabase must be taken online when task type is 0 or 1.The database must be connected if the task type is 0 or 1.
    400InvalideStatusParent migrate task status is invalid.The parent migration task is abnormal.
    400InvalidOssObjectStorageClassTypeThe specified OSS bucket storage type is invalid.The storage class of the OSS bucket that stores the file is invalid.
    400EngineNotSupportedEngine 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.
    400EngineVersionNotSupportedEngineVersion specified cannot be replicate with the source DB Instance.Instance cloning is not supported for the database engine version of the current instance.
    403InvalidInstanceStateThe DB instance state does not support this operation.The operation failed. The RDS instance is unavailable.
    404BakFilesNeededBackup file does not supply.-

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

    Change history

    Change timeSummary of changesOperation
    2023-03-28The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
      Added Error Codes: 404
    2022-10-28The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403