调用CreateMigrateTask接口将OSS上的备份文件还原到RDS SQL Server实例,实现数据上云。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateMigrateTask

系统规定参数。取值:CreateMigrateTask

DBInstanceId String rm-uf6wjk5xxxxxxx

实例ID。

DBName String testDB

目标数据库名称。

BackupMode String FULL

迁移上云任务类型,取值:

  • FULL:通过全量备份文件去执行还原操作。
  • UPDF:通过增量文件或者日志文件去还原增量部分的数据。
IsOnlineDB String True

是否将还原后的数据库带上线,便于用户访问,取值:

  • True:将数据库带上线。
  • False:不将数据库带上线。
说明 目前SQL Server 2008 R2 版本该值恒定为True
CheckDBMode String AsyncExecuteDBCheck

打开数据库后一致性检查方法,取值:

  • SyncExecuteDBCheck:同步执行DB检查。
  • AsyncExecuteDBCheck:异步执行DB检查。

默认值为AsyncExecuteDBCheck(兼容 SQL Server 2008 R2)。

说明IsOnlineDB=True时,该值有效。
OssObjectPositions String oss-ap-southeast-1.aliyuncs.com:rdsmssqlsingapore:autotest_2008R2_TestMigration_FULL.bak

OSS的组成部分。

取值由3段组成,用英文冒号(:)分隔:

  • OSS Endpoint地址:oss-ap-southeast-1.aliyuncs.com。
  • OSS Bucket名字:rdsmssqlsingapore。
  • OSS上的备份文件Key:autotest_2008R2_TestMigration_FULL.bak。
说明
  • 该参数对于 SQL Server 2008 R2 版本实例是可选参数。
  • 该参数对于 SQL Server 2008 R2 以上版本实例是必传参数。
OSSUrls String check_cdn_oss.sh www.xxxxxx.mobi

备份文件所在OSS共享URL地址(Encode编码后的URL)。

有多个地址时,先使用“|”隔开,再编码后传入参数。

说明 SQL Server 2008 R2 必须传入该参数。
MigrateTaskId String

迁移任务ID:

  • BackupMode=FULL时,该值为空。(兼容RDS for SQLServer 2008 R2)。
  • BackupMode=UPDF时,该值为对应FULL任务的ID。
说明
  • IsOnlineDB=True时,BackupMode必须取值为FULL
  • IsOnlineDB=False时,BackupMode必须为UPDF

返回数据

名称 类型 示例值 描述
RequestId String 866F5EB8-4650-4061-87F0-379F6F968BCE

请求ID。

DBName String test02

数据库名称。

BackupMode String FULL

迁移上云任务类型,取值为:

  • FULL:通过全量备份文件去执行还原操作。
  • UPDF:通过增量文件或者日志文件去还原增量部分的数据。
DBInstanceId String rm-uf6wjk5xxxxx

实例ID。

MigrateTaskId String 564563256

迁移任务ID。

TaskId String 5451225

任务ID。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=CreateMigrateTask
&DBInstanceId=rm-uf6wjk5xxxxxxx
&DBName=testDB
&BackupMode=FULL
&IsOnlineDB=True
&OssObjectPositions=oss-ap-southeast-1.aliyuncs.com:rdsmssqlsingapore:autotest_2008R2_TestMigration_FULL.bak
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<CreateMigrateTaskResponse>
	<MigrateTaskId>135847</MigrateTaskId>
	<DBInstanceId>rm-bp178grbxxxxxxx</DBInstanceId>
	<RequestId>5F2B3757-BD56-40B3-B5F2-FCDD9FA0E2E2</RequestId>
	<BackupMode>UPDF</BackupMode>
	<TaskId>128301751</TaskId>
	<DBName>test02</DBName>
</CreateMigrateTaskResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "MigrateTaskId" : "135847",
  "DBInstanceId" : "rm-bp178grbxxxxxxx",
  "RequestId" : "5F2B3757-BD56-40B3-B5F2-FCDD9FA0E2E2",
  "BackupMode" : "UPDF",
  "TaskId" : "128301751",
  "DBName" : "test02"
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidFile The operation does not support this kind of file 操作失败,不支持此类文件。
400 InvalidInstanceType The DB instance type does not support this operation. 操作失败,当前实例类型不支持此操作。
400 InvalidInstanceLockMode The DB instance lock mode does not support this operation. 实例锁定模式不支持此操作。
400 InvalidDBName The instance does not have the specified DB name. 目标数据库不存在,请确认目标数据库名称正确性及状态,或更换其他数据库。
400 InvalidDBType The DB type does not support this operation. 操作失败,数据库状态不支持此操作。
400 InvalidDBState The DB state does not support this operation. 操作失败,数据库状态不支持此操作。
400 ExceedUploadTime Exceeding the daily upload times of this DB. 下载次数超过数据库每日上限。
400 InvalidOSSURL The Specified OSS URL is not valid OSS的地址信息错误,请检查。
400 ExceedDiskSize The file size exceeding the disk size 文件大小超过磁盘容量,请检查后重试。
400 InvalideStatus Parent migrate task status is invalid. 父迁移任务状态异常
400 InvalidOssObjectStorageClassType The specified OSS bucket storage type is invalid. 指定文件的OSS Bucket存储类型无效.
403 InvalidInstanceState The DB instance state does not support this operation. 操作失败,当前实例不可用。

访问错误中心查看更多错误码。