调用ModifyDtsJob接口修改同步任务。
说明 您可以根据需求在控制台进行相应的预配置，然后预览对应配置的OpenAPI参数信息，以协助您填写请求参数。更多信息，请参见预览OpenAPI的请求参数。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
|
名称 |
类型 |
是否必选 |
示例值 |
描述 |
| Action | String | 是 | ModifyDtsJob | 系统规定参数。取值：ModifyDtsJob。 |
| RegionId | String | 否 | cn-hangzhou | 实例所在区域，详情请参见支持的地域列表。 |
| DtsInstanceId | String | 是 | dtsbi6e22ay243**** | 同步实例ID。 |
| SynchronizationDirection | String | 否 | Forward | 指定同步方向，取值：
说明
|
| ClientToken | String | 否 | 0c593ea1-3bea-11e9-b96b-88e9fe63**** | 保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。 |
| DbList | Map | 否 | {"dtstest":{"name":"dtstest","all":true}} | 修改后的同步对象，格式为JSON串。详细定义，请参见迁移、同步或订阅对象说明。 说明
|
| EtlOperatorColumnReference | String | 否 | { "configKeyMap": [ { "moduleCode": "03", "etlOperatorColumnReference": "etlOperatorColumnReference", "etlOperatorSetting": "etlOperatorSetting" }, { "moduleCode": "07", "etlOperatorColumnReference": "etlOperatorColumnReference", "etlOperatorSetting": "etlOperatorSetting" } ], "amp.increment.replicator.compare.all.columns.enable": false, "srcNetType": "VPC", "etlOperatorColumnReference": { "MODIFY_TIME": [ { "datasynchron.test_timing_user_000": "user_create_date" }, { "datasynchron.test_timing_user_001": "user_create_date" }, { "datasynchron.test_timing_user_002": "user_create_date" }, { "datasynchron.test_timing_user_003": "user_create_date" } ] }, "destNetType": "VPC", "originalSrcDbInst": "sg-sit-db2-primary.mysql.polardb.rds.aliyuncs.com", "etlOperatorSetting": "adb_time_travel", "sjobUseJobTask": "1", "srcVpcNetMappingInst": "172.19.XXX.XXX:4261", "destVpcNetMappingInst": "172.19.XXX.XXX:4260", "useJobTask": "1" } | T+1业务专用的字段，ETL算子，为业务专用字段。 |
| ModifyTypeEnum | String | 否 | UPDATE_RESERVED | 指示修改同步任务的方式，不填默认修改同步对象；填写UPDATE_RESERVED为修改预留参数。 |
| Reserved | String | 否 | {\"srcHostPorts\":\"\",\"whitelist.dms.online.ddl.enable\":false,\"filterDDL\":false,\"sqlparser.dms.original.ddl\":true,\"srcOracleType\":\"sid\",\"maxRetryTime\":43200,\"destSSL\":\"0\",\"destOracleType\":\"sid\",\"srcSSL\":\"0\",\"dbListCaseChangeMode\":\"default\",\"SourceEngineVersion\":\"8.0.18\",\"srcNetType\":\"VPC\",\"destNetType\":\"VPC\",\"srcVpcNetMappingInst\":\"172.16.1**.**:10803\",\"destVpcNetMappingInst\":\"172.16.1**.**:11077\",\"useJobTask\":\"1\"} | DTS预留参数，更新方式为新增而非覆盖，格式为MAP JSON串，您可以传入本参数实现特殊需求（例如是否自动启动预检查）。更多信息，请参见MigrationReserved参数说明。 |
| FileOssUrl | String | 否 | http://db-list-os-file.oss-cn-shanghai.aliyuncs.com/8e42_12185******43989_************ | 同步文件的OSS地址。 |
| FilterTableName | String | 否 | testtable | 需要过滤的表名。 |
| StructureInitialization | Boolean | 否 | true | 是否执行库表结构迁移或初始化，取值：
|
| DataInitialization | Boolean | 否 | true | 是否执行全量数据迁移或全量数据初始化，取值：
|
| DataSynchronization | Boolean | 否 | true | 是否执行增量数据迁移或同步，取值：
|
| DtsJobId | String | 否 | fpx1149rw7p*** | 同步任务的ID，可调用DescribeDtsJobs查询。 |
| ZeroEtlJob | Boolean | 否 | false | 是否无感集成（Zero-ETL）任务，取值：
|
| ResourceGroupId | String | 否 | rg-acfmzawhxxc**** | 资源组ID。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
| Status | String | 200 | 状态码。 |
| RequestId | String | 1D6ECADF-C5E9-4C96-8811-77602B31**** | 请求ID。 |
| DtsJobId | String | bi6e22a**** | DTS任务ID。 |
| ErrCode | String | InternalError | 调用出错时返回的错误码。 |
| Success | Boolean | true | 请求是否成功。 |
| ErrMessage | Boolean | true | 调用出错时返回的错误信息。 说明 该参数的数据类型应为String，实际示例值为The request processing has failed due to some unknown error. |
示例
请求示例
http(s)://dts.aliyuncs.com/?Action=ModifyDtsJob
&DtsInstanceId=dtsbi6e22ay243****
&DbList={"dtstest":{"name":"dtstest","all":true}}
&<公共请求参数>正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ModifyDtsJobResponse>
<DtsJobId>bi6e22a****</DtsJobId>
<RequestId>1D6ECADF-C5E9-4C96-8811-77602B31****</RequestId>
<Success>true</Success>
</ModifyDtsJobResponse>JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"DtsJobId" : "bi6e22a****",
"RequestId" : "1D6ECADF-C5E9-4C96-8811-77602B31****",
"Success" : true
}错误码
|
HttpCode |
错误码 |
错误信息 |
描述 |
| 403 | OperationDenied.JobStatusModifying | jobs state is modifying, please wait sync subtask ends | 该任务处于修改同步对象中（之前修改同步对象操作尚未完成），请等待该状态结束 |
| 403 | CheckStatus.InvalidInitStatus | Task has not been configured, please configure job first | 任务尚未配置，修改任务之前请先配置任务 |
| 403 | DTS.Msg.OperationDenied.JobStatusModifying | jobs state is modifying, please wait sync subtask ends | 该任务处于修改同步对象中（之前修改同步对象操作尚未完成），请等待该状态结束 |
| 403 | DTS.Msg.CheckStatus.InvalidInitStatus | Task has not been configured, please configure job first | 任务尚未配置，修改任务之前请先配置任务 |
| 403 | InvalidSecurityToken.Expired | Specified SecurityToken is expired. | 签名已经过期，请更新签名 |
| 400 | Throttling.User | Request was denied due to user flow control. | 由于请求频次达到阈值，请求被拒绝，请稍后重试。 |
| 500 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | 由于服务端响应超时或者不可用导致请求失败，请重试，重试后仍失败请联系技术支持。 |
访问错误中心查看更多错误码。
文档内容是否对您有帮助？