修改数据迁移任务

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

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 公共参数,本接口取值:ModifyMigrateJob
Version String 公共参数,本接口取值:2018-03-30
Region String 公共参数,详见产品支持的地域列表
JobId String 待修改的数据迁移任务ID
JobName String 数据迁移任务名称
MigrateOption MigrateOption 迁移任务配置选项
SrcAccessType String 源实例接入类型,值包括:extranet(外网),cvm(cvm自建实例),dcg(专线接入的实例),vpncloud(云vpn接入的实例),vpnselfbuild(自建vpn接入的实例),cdb(云上cdb实例)
SrcInfo SrcInfo 源实例信息,具体内容跟迁移任务类型相关
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. 输出参数

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

4. 示例

示例1 修改数据迁移任务

输入示例

https://dts.tencentcloudapi.com/?Action==ModifyMigrateJob
&JobId=dts-1kl0iy0v
&JobName=userdts
&DatabaseInfo=[{"Database":"test","Table":["user","log"]}]
&MigrateOption.RunMode=1
&MigrateOption.MigrateType=2
&MigrateOption.MigrateObject=2
&MigrateOption.ConsistencyType=5
&MigrateOption.IsOverrideRoot=0
&DstInfo.ReadOnly=0
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "27ef2b7c-a786-48b4-9404-2f9baf3f4916"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.NotAllowOperation 禁止该操作。
InternalError.DatabaseError 迁移平台数据库访问失败。
InternalError.DuplicateJob 迁移任务冲突。
InternalError.ProtocolError 通信协议错误。
InvalidParameter 参数错误
ResourceNotFound.JobNotExist 迁移任务不存在。