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

调试

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

请求参数

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

系统规定参数，取值：CreateMigrateTask。

BackupMode String 是 FULL

迁移上云任务类型，取值：

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

实例ID。
DBName String 是 testDB

目标数据库名称。
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。

默认值为FULL。

说明
  • IsOnlineDB=True时，BackupMode必须取值为FULL。
  • IsOnlineDB=False时，BackupMode必须为UPDF。

返回数据

名称 类型 示例值 描述
BackupMode String FULL

迁移上云任务类型，取值为：

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

实例ID。
DBName String test02

数据库名称。
MigrateTaskId String 564563256

迁移任务ID。
RequestId String 866F5EB8-4650-4061-87F0-379F6F968BCE

请求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 格式 

<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 格式 

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

错误码

HttpCode 错误码 错误信息 描述
400 InvalidDBName The instance does not have the specified DB name. 指定数据库名不存在。

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