该接口用于将OSS上的备份文件还原到RDS SQL Server实例，实现数据上云。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:CreateMigrateTask | WRITE |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 实例ID。 | rm-uf6wjk5**** |
| DBName | string | 是 | 目标数据库名称。 | testDB |
| BackupMode | string | 是 | 迁移上云任务类型，取值：
| FULL |
| IsOnlineDB | string | 是 | 是否将还原后的数据库带上线，便于用户访问，取值：
说明
目前SQL Server 2008 R2 版本该值恒定为True。
| True |
| CheckDBMode | string | 否 | 打开数据库后一致性检查方法，取值：
默认值为AsyncExecuteDBCheck（兼容 SQL Server 2008 R2）。 说明
当IsOnlineDB=True时，该值有效。
| AsyncExecuteDBCheck |
| OssObjectPositions | string | 否 | OSS的组成部分。 取值由3段组成，用英文冒号（:）分隔：
说明
| oss-ap-southeast-1.aliyuncs.com:rdsmssqlsingapore:autotest_2008R2_TestMigration_FULL.bak |
| OSSUrls | string | 否 | 备份文件所在OSS共享URL地址（Encode编码后的URL）。 有多个地址时，先使用“|”隔开，再编码后传入参数。 说明
SQL Server 2008 R2 必须传入该参数。
| check_cdn_oss.sh www.******.mobi |
| MigrateTaskId | string | 否 | 迁移任务ID：
说明
| 无 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "866F5EB8-4650-4061-87F0-379F6F968BCE",
"DBName": "test02",
"BackupMode": "FULL",
"DBInstanceId": "rm-uf6wjk5****",
"MigrateTaskId": "564563****",
"TaskId": "545****"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 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 | EntityNotExist.Role | The role not exists | 角色不存在 |
| 400 | DatabaseMustOnline | Database must be taken online when task type is 0 or 1. | 当任务类型为0或1时，数据库必须联机。 |
| 400 | InvalideStatus | Parent migrate task status is invalid. | 父迁移任务状态异常 |
| 400 | InvalidOssObjectStorageClassType | The specified OSS bucket storage type is invalid. | 指定文件的OSS Bucket存储类型无效. |
| 400 | EngineNotSupported | Engine specified cannot be supported the operation. | 操作失败，当前引擎不支持此操作，请升级内核小版本。 |
| 400 | EngineVersionNotSupported | EngineVersion specified cannot be replicate with the source DB Instance. | 当前数据库引擎版本不支持克隆实例。 |
| 403 | InvalidInstanceState | The DB instance state does not support this operation. | 操作失败，当前实例不可用。 |
| 404 | BakFilesNeeded | Backup file does not supply. | 备份文件未提供。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2023-03-28 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2022-10-28 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
|