CreateMigrateTask - 创建上云迁移任务

更新时间: 2023-09-26 15:03:34

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

接口说明

适用引擎

RDS SQL Server

相关功能文档

注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。
SQL Server实例级别迁移上云

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:CreateMigrateTaskWRITE
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例ID。

rm-uf6wjk5****
DBNamestring

目标数据库名称。

testDB
BackupModestring

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

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

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

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

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

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

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

说明 IsOnlineDB=True时,该值有效。
AsyncExecuteDBCheck
OssObjectPositionsstring

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以上版本实例是必传参数。
  • oss-ap-southeast-1.aliyuncs.com:rdsmssqlsingapore:autotest_2008R2_TestMigration_FULL.bak
    OSSUrlsstring

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

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

    说明 SQL Server 2008 R2 必须传入该参数。
    check_cdn_oss.sh www.******.mobi
    MigrateTaskIdstring

    迁移任务ID:

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

    名称类型描述示例值
    object
    RequestIdstring

    请求ID。

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

    数据库名称。

    test02
    BackupModestring

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

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

    实例ID。

    rm-uf6wjk5****
    MigrateTaskIdstring

    迁移任务ID。

    564563****
    TaskIdstring

    任务ID。

    545****

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "866F5EB8-4650-4061-87F0-379F6F968BCE",
      "DBName": "test02",
      "BackupMode": "FULL",
      "DBInstanceId": "rm-uf6wjk5****",
      "MigrateTaskId": "564563****",
      "TaskId": "545****"
    }

    错误码

    HTTP status code错误码错误信息描述
    400InvalidFileThe operation does not support this kind of file操作失败,不支持此类文件。
    400InvalidInstanceTypeThe DB instance type does not support this operation.操作失败,当前实例类型不支持此操作。
    400InvalidInstanceLockModeThe DB instance lock mode does not support this operation.实例锁定模式不支持此操作。
    400InvalidDBNameThe instance does not have the specified DB name.目标数据库不存在,请确认目标数据库名称正确性及状态,或更换其他数据库。
    400InvalidDBTypeThe DB type does not support this operation.操作失败,数据库状态不支持此操作。
    400InvalidDBStateThe DB state does not support this operation.操作失败,数据库状态不支持此操作。
    400ExceedUploadTimeExceeding the daily upload times of this DB.下载次数超过数据库每日上限。
    400InvalidOSSURLThe Specified OSS URL is not validOSS的地址信息错误,请检查。
    400ExceedDiskSizeThe file size exceeding the disk size文件大小超过磁盘容量,请检查后重试。
    400EntityNotExist.RoleThe role not exists角色不存在
    400DatabaseMustOnlineDatabase must be taken online when task type is 0 or 1.当任务类型为0或1时,数据库必须联机。
    400InvalideStatusParent migrate task status is invalid.父迁移任务状态异常
    400InvalidOssObjectStorageClassTypeThe specified OSS bucket storage type is invalid.指定文件的OSS Bucket存储类型无效.
    400EngineNotSupportedEngine specified cannot be supported the operation.操作失败,当前引擎不支持此操作,请升级内核小版本。
    400EngineVersionNotSupportedEngineVersion specified cannot be replicate with the source DB Instance.当前数据库引擎版本不支持克隆实例。
    403InvalidInstanceStateThe DB instance state does not support this operation.操作失败,当前实例不可用。
    404BakFilesNeededBackup file does not supply.备份文件未提供。

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

    变更历史

    变更时间变更内容概要操作
    2023-03-28OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      新增错误码:404
    2022-10-28OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
      删除错误码:403
    阿里云首页 云数据库 RDS 相关技术圈