文档

CreateMigrateTask - 创建上云迁移任务

更新时间:

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

接口说明

适用引擎

RDS SQL Server

使用限制

不支持跨阿里云账号迁移数据。例如,不支持将主账号 A 中 OSS 上的备份文件迁移至主账号 B 中的 RDS SQL Server 实例中。

说明 必要时,您可以先将源账号 A 下的 OSS 数据迁移到目标账号 B 下的 OSS 存储空间,确保 OSS 数据和 RDS SQL Server 实例在同一阿里云主账号下时,再使用本文接口创建迁移任务。相关操作,请参见使用在线迁移服务跨账号迁移 OSS 数据

相关功能文档

注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件准备工作及使用后造成的影响后,再进行操作。
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。可调用 DescribeDBInstances 获取。

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 时,该值为空。(兼容 SQL Server 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.当前数据库引擎版本不支持克隆实例。
    400BakFileSizeExceededExceeding the allowed backup file size.备份文件大小超过允许值。
    400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
    400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
    400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
    400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
    400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
    400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.客户您好,阿里云计划对当前地域进行优化调整,该区域云服务将停止运营,为确保您的业务连续性及数据迁移工作的平稳过渡,您目前无法操作新购类型的订单,感谢理解与支持。
    400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.您购买的模块不合法,请重新购买。
    400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.客户您好,印度地域裁撤,购买的服务效期不能超过2024.07.15。
    400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.客户您好,澳洲地域裁撤,购买的服务效期不能超过2024.09.30
    400Price.CommoditySysCommodity system call exception.商品系统调用异常。
    400Pay.InsufficientBalanceInsufficient available balance.可用金不足。
    400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.您选购的周期有问题,请重新选购。
    400pay.noCreditCardAccount not bound to credit card.账户未绑定信用卡。
    400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.您选购的服务存在未支付订单,请支付或作废后再下单。
    400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
    400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.您的基本信息未完善,请在操作前先完善您的基本信息。
    400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.您的账户出现异常,详情请联系客服。
    400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.您的信息不完整,请在操作前填写您的信息。
    400Api.NotSupportSpecified api is not supported.当前接口不支持。
    400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.存在禁止下单的标签,请联系您的分销商处理
    400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.提供的DBInstanceId不存在。
    400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk type当前实例规格不支持该存储类型。
    400InvalidParamSepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.指定的 wal_level 参数无效。实例中仍然存在复制槽,因此无法将其设置为replica。
    400KmsApiErrorUser secret key invalid.用户密钥失效。
    400System.SaleValidateFailedSales expression validation system error.销售表达式校验系统错误。
    400Abs.InvalidAccount.NotFoundaccount is not found.账户不存在。
    403InvalidInstanceStateThe DB instance state does not support this operation.操作失败,当前实例不可用。
    403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单,请支付后重试。
    403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.缩容目标容量不能小于当前存储空间使用量
    403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.SSD盘不支持此操作,请升级至ESSD。
    403InvalidUserOperatorPermissionThe user permission does not support this operation.用户权限不支持此操作。
    403InvalidVswitchIdSpecified conn vswitch id is not valid.指定的VSwitchId格式不正确或为空
    404BakFilesNeededBackup file does not supply.备份文件未提供。
    404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.当前实例未授权访问密钥管理服务。
    500ExternalFailureThe request processing has failed due to external service failure.请求服务失败,请稍后重试。

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

    变更历史

    变更时间变更内容概要操作
    2024-05-22OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
      删除错误码:403
      删除错误码:404
    2023-03-28OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      新增错误码:404
    2022-10-28OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
      删除错误码:403
    • 本页导读 (1)