修改DTS任务的同步对象
更新时间 2026-06-16 17:06:01
最近更新时间: 2026-06-16 17:06:01
接口功能介绍
修改 DTS 任务的同步对象。
接口约束
无
URI
POST /dts/v2/open-api/instance/modifyDtsJob
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池id | 200000001790 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| dtsJobId | 是 | Integer | 任务id | 112233445566 | |
| dbList | 否 | String | 待同步数据库对象 | new_dts_job_name | |
| modifyTypeEnum | 否 | String | 修改类型：UPDATE_DB_LIST, UPDATE_EXT_PROPERTIES | UPDATE_DB_LIST | |
| extraProperties | 否 | String | 扩展配置信息 | new_dts_job_name | |
| dataInitialization | 否 | Boolean | 是否迁移全量数据 | true | |
| dataSynchronization | 否 | Boolean | 是否迁移增量数据 | true | |
| structureInitialization | 否 | Boolean | 是否执行结构迁移 | true |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| httpStatusCode | Integer | 状态码 | ||
| errCode | String | 错误码 | ||
| errMessage | String | 提示信息 | ||
| success | Boolean | 请求是否成功 | ||
| requestId | String | 请求id | ||
| dtsJobId | Integer | 数据同步任务ID |
枚举参数
无
请求示例
请求url
https://{host}/dts/v2/open-api/instance/modifyDtsJob
请求头header
无
请求体body
{
"dtsJobId": "419",
"dbList": "{\"sync_m2m\":{\"name\":\"sync_m2m\",\"all\":true,\"ddl_op\":\"\",\"dml_op\":\"i,u,d\"},\"sync_m2m_1\":{\"name\":\"sync_m2m_1\",\"all\":true,\"ddl_op\":\"\",\"dml_op\":\"i,u,d\"},\"sync_m2m_big\":{\"name\":\"sync_m2m_big\",\"all\":true,\"ddl_op\":\"\",\"dml_op\":\"i,u,d\"}}",
"modifyTypeEnum": "UPDATE_DB_LIST",
"dataInitialization": true,
"dataSynchronization": true,
"structureInitialization": true
}
响应示例
{
"httpStatusCode": 200,
"success": true,
"requestId": "00-6a2b78962de20d29e84197ca2514cfd1-13ea274a826d8c6e-00",
"dtsJobId": 419
}
状态码
请参考 状态码
错误码
请参考 错误码
