1. 接口描述
接口请求域名： dts.tencentcloudapi.com 。
本接口（ModifyMigrateJob）用于修改数据迁移任务。
当迁移任务处于下述状态时，允许调用本接口修改迁移任务：迁移创建中（status=1）、 校验成功(status=4)、校验失败(status=5)、迁移失败(status=10)。但源实例、目标实例类型和目标实例地域不允许修改。
如果是金融区链路, 请使用域名: dts.ap-shenzhen-fsi.tencentcloudapi.com
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyMigrateJob。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-30。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| JobId | 是 | String | 待修改的数据迁移任务ID 示例值：dts-75sekyal |
| JobName | 否 | String | 数据迁移任务名称 示例值：test |
| MigrateOption | 否 | MigrateOption | 迁移任务配置选项 |
| SrcAccessType | 否 | String | 源实例接入类型，值包括：extranet(外网),cvm(CVM自建实例),dcg(专线接入的实例),vpncloud(云VPN接入的实例),cdb(云上CDB实例) 示例值：cvm |
| SrcInfo | 否 | SrcInfo | 源实例信息，具体内容跟迁移任务类型相关 |
| DstAccessType | 否 | String | 目标实例接入类型，值包括：extranet(外网),cvm(CVM自建实例),dcg(专线接入的实例),vpncloud(云VPN接入的实例)，cdb(云上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"}] 如果是'整个实例'的迁移模式,不需设置该字段 |
| SrcNodeType | 否 | String | 源实例类型: ""或者"simple":主从节点，"cluster": 集群节点 示例值：cluster |
| SrcInfoMulti.N | 否 | Array of SrcInfo | 源实例信息，具体内容跟迁移任务类型相关 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改数据迁移任务
修改dts-1kl0iy0v迁移任务配置
输入示例
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
&DstInfo.Region=ap-guangzhou
&SrcInfo.Supplier=others
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "27ef2b7c-a786-48b4-9404-2f9baf3f4916"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.NotAllowOperation | 禁止该操作。 |
| InternalError.DatabaseError | 迁移平台数据库访问失败。 |
| InternalError.DuplicateJob | 迁移任务冲突。 |
| InternalError.ProtocolError | 通信协议错误。 |
| InternalError.UnknownError | 未知的内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.BizInvalidParameterValueError | 业务参数错误。 |
| InvalidParameterValue.DataConvertError | 数据转换错误。 |
| ResourceNotFound.JobNotExist | 迁移任务不存在。 |
| UnauthorizedOperation.NotEnoughPrivileges | 认证失败，没有足够权限。 |
