調用CreateMigrateTask介面將OSS上的備份檔案還原到RDS執行個體，實現資料上雲。

調試

您可以在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。

預設值為FULL。

说明
  • IsOnlineDB=True時，BackupMode必須取值為FULL；
  • IsOnlineDB=False時，BackupMode必須為UPDF。
AccessKeyId String 否 LTAIKw8gxxxx

阿里雲頒發給使用者的訪問服務所用的密鑰ID。

返回資料

名稱 類型 樣本值 描述
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",
	"RequestId":"5F2B3757-BD56-40B3-B5F2-FCDD9FA0E2E2",
	"DBInstanceId":"rm-bp178grbxxxxxxx",
	"BackupMode":"UPDF",
	"TaskId":"128301751",
	"DBName":"test02"
}

錯誤碼

HttpCode 錯誤碼 錯誤資訊 描述
400 InvalidDBName The instance does not have the specified DB name. 指定資料庫名不存在。

訪問錯誤中心查看更多錯誤碼。