CreateMigrateTask - 创建上云迁移任务_云数据库 RDS(RDS)-阿里云帮助中心

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

接口说明

适用引擎

RDS SQL Server

使用限制

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

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
rds:CreateMigrateTask	Write	DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。可调用 DescribeDBInstances 获取。	rm-uf6wjk5****
DBName	string	是	目标数据库名称。	testDB
BackupMode	string	是	迁移上云任务类型，取值： FULL：通过全量备份文件去执行还原操作。 UPDF：通过增量文件或者日志文件去还原增量部分的数据。	FULL
IsOnlineDB	string	是	是否将还原后的数据库带上线，便于用户访问，取值： True：将数据库带上线。 False：不将数据库带上线。说明目前 SQL Server 2008 R2 版本该值恒定为 True。	True
CheckDBMode	string	否	打开数据库后一致性检查方法，取值： SyncExecuteDBCheck：同步执行 DB 检查。 AsyncExecuteDBCheck：异步执行 DB 检查。默认值为 AsyncExecuteDBCheck（兼容 SQL Server 2008 R2）。说明当 IsOnlineDB=True 时，该值有效。	AsyncExecuteDBCheck
OssObjectPositions	string	否	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
OSSUrls	string	否	备份文件所在 OSS 共享 URL 地址（Encode 编码后的 URL）。有多个地址时，先使用“\|”隔开，再编码后传入参数。说明 SQL Server 2008 R2 必须传入该参数。	check_cdn_oss.sh www.******.mobi
MigrateTaskId	string	否	迁移任务 ID： BackupMode=FULL 时，该值为空。（兼容 SQL Server 2008 R2）。 BackupMode=UPDF 时，该值为对应 FULL 任务的 ID。说明 IsOnlineDB=True 时，BackupMode 必须取值为 FULL。 IsOnlineDB=False 时，BackupMode 必须为 UPDF。	无

返回参数

名称	类型	描述	示例值
	object	返回参数详情。
RequestId	string	请求 ID。	866F5EB8-4650-4061-87F0-379F6F968BCE
DBName	string	数据库名称。	test02
BackupMode	string	迁移上云任务类型，取值为： FULL：通过全量备份文件去执行还原操作。 UPDF：通过增量文件或者日志文件去还原增量部分的数据。	FULL
DBInstanceId	string	实例 ID。	rm-uf6wjk5****
MigrateTaskId	string	迁移任务 ID。	564563****
TaskId	string	任务 ID。	545****

示例

正常返回示例

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.	当前数据库引擎版本不支持克隆实例。
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	套餐实例不允许单独操作。
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	定价计划价格结果没有找到。
400	Order.NoRealNameAuthentication	You 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.	您还未通过实名认证，不符合购买条件，请登录用户中心进行实名认证。
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	您的账户可用额度小于0，请先充值后再尝试购买。
400	CommodityServiceCalling.Exception	Failed to call commodity service.	调用商品服务返回失败。
400	RegionDissolvedEOM	Dear 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.	客户您好，阿里云计划对当前地域进行优化调整，该区域云服务将停止运营，为确保您的业务连续性及数据迁移工作的平稳过渡，您目前无法操作新购类型的订单，感谢理解与支持。
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	您购买的模块不合法，请重新购买。
400	RegionEndTimeDissolvedIndia	Cloud 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。
400	RegionEndTimeDissolvedAustralia	Cloud 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
400	Price.CommoditySys	Commodity system call exception.	商品系统调用异常。
400	Pay.InsufficientBalance	Insufficient available balance.	可用金不足。
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	您选购的周期有问题，请重新选购。
400	pay.noCreditCard	Account not bound to credit card.	账户未绑定信用卡。
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	您选购的服务存在未支付订单，请支付或作废后再下单。
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	您的基本信息未完善，请在操作前先完善您的基本信息。
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	您的账户出现异常，详情请联系客服。
400	BasicInfoUncompleted	Your information is incomplete, Complete your information before the operation.	您的信息不完整，请在操作前填写您的信息。
400	System.SaleValidateFailed	Sales expression validation system error.	销售表达式校验系统错误。
403	InvalidInstanceState	The DB instance state does not support this operation.	操作失败，当前实例不可用。
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	实例当前存在未支付订单，请支付后重试。
404	BakFilesNeeded	Backup file does not supply.	备份文件未提供。

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

变更历史

变更时间

变更内容概要

操作

2023-03-28

OpenAPI 错误码发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400
	删除错误码：403
	新增错误码：404

2022-10-28