创建数据迁移任务

最近更新时间:2018-09-18 17:00:21

1. 接口描述

接口请求域名: dts.tencentcloudapi.com 。

本接口用于创建数据迁移任务。

如果是金融区链路, 请使用域名: dts.ap-shenzhen-fsi.tencentcloudapi.com

默认接口请求频率限制:20次/每秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi )时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:dts.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateMigrateJob
Version String 公共参数,本接口取值:2018-03-30
Region String 公共参数,详见产品支持的地域列表
JobName String 数据迁移任务名称
MigrateOption MigrateOption 迁移任务配置选项
SrcDatabaseType String 源实例数据库类型:mysql,redis,mongodb
SrcAccessType String 源实例接入类型,值包括:extranet(外网),cvm(cvm自建实例),dcg(专线接入的实例),vpncloud(云vpn接入的实例),vpnselfbuild(自建vpn接入的实例),cdb(云上cdb实例)
SrcInfo SrcInfo 源实例信息,具体内容跟迁移任务类型相关
DstDatabaseType String 目标实例数据库类型,mysql,redis,mongodb
DstAccessType String 目标实例接入类型,值包括:extranet(外网),cvm(cvm自建实例),dcg(专线接入的实例),vpncloud(云vpn接入的实例),vpnselfbuild(自建vpn接入的实例),cdb(云上cdb实例). 目前只支持cdb.
DstInfo DstInfo 目标实例信息
DatabaseInfo String 需要迁移的源数据库表信息,用json格式的字符串描述。
对于database-table两级结构的数据库:
[{Database:db1,Table:[table1,table2]},{Database:db2}]
对于database-schema-table三级结构:
[{Database:db1,Schema:s1
Table:[table1,table2]},{Database:db1,Schema:s2
Table:[table1,table2]},{Database:db2,Schema:s1
Table:[table1,table2]},{Database:db3},{Database:db4
Schema:s1}]

3. 输出参数

参数名称 类型 描述
JobId String 数据迁移任务ID
RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

4. 示例

示例1 创建数据迁移任务

输入示例

https://dts.tencentcloudapi.com/?Action=CreateMigrateJob
&JobName=usertest
&SrcDatabaseType=mysql
&SrcAccessType=extranet
&DstDatabaseType=mysql
&DstAccessType=cdb
&MigrateOption.RunMode=1
&MigrateOption.MigrateType=1
&MigrateOption.MigrateObject=1
&MigrateOption.ConsistencyType=1
&MigrateOption.IsOverrideRoot=0
&SrcInfo.Ip=14.17.22.36
&SrcInfo.Port=10301
&SrcInfo.User=root
&SrcInfo.Supplier=others
&SrcInfo.Password=123456
&SrcInfo.Region=ap-guangzhou
&DstInfo.InstanceId=cdb-e78e0nnv
&DstInfo.Region=ap-shanghai
&<公共请求参数>

输出示例

{
  "Response": {
    "JobId": "dts-1kl0iy0v",
    "RequestId": "2201c42a-714f-4faa-915b-a51cc09f5cec"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、 SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集( SDK ),支持多种编程语言,能更方便的调用 API 。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
FailedOperation.NotAllowOperation 禁止该操作。
InternalError.DatabaseError 迁移平台数据库访问失败。
InternalError.DuplicateJob 迁移任务冲突。
InternalError.ProtocolError 通信协议错误。
InvalidParameter 参数错误
LimitExceeded.MaxUnusedJobs 闲置迁移任务数目超过限制。