Data Transmission Service:ModifyDtsJob

Action

String

Yes

ModifyDtsJob

The system-defined parameter. Set the value to ModifyDtsJob.

RegionId

String

No

cn-hangzhou

The region ID of the instance. For more information, see Supported regions.

DtsInstanceId

String

Yes

dtsbi6e22ay243****

The ID of the synchronization instance.

SynchronizationDirection

String

No

Forward

The synchronization direction. Valid values:

• Forward: Forward synchronization.

• Reverse: Reverse synchronization.

ClientToken

String

No

0c593ea1-3bea-11e9-b96b-88e9fe63****

The client token that ensures the idempotency of the request. Generate a unique parameter value from your client for different requests. ClientToken supports ASCII characters only and cannot exceed 64 characters in length.

DbList

Map

No

{"dtstest":{"name":"dtstest","all":true}}

The modified synchronization objects in JSON string format. For more information, see Objects for migration, synchronization, and subscription.

• Important: The existing DbList will be overwritten by the new DbList. Make sure that the new DbList contains all required synchronization objects. Otherwise, synchronization objects may be lost. Modify with caution.

• Recommendation: Before modifying, call DescribeDtsJobDetail in advance to query the current synchronization objects, and then enter the modified synchronization objects according to your business needs. For example, if the current objects are Table A and Table B and you need to add Table C, you must include Table A, Table B, and Table C in this parameter.

• DbList supports a maximum of 1 MB of data.

• If DbList contains filter conditions, the total length of DbList (including filter conditions) supports a maximum of 1 MB.

• For distributed tasks (such as migration or synchronization tasks with PolarDB-X 1.0 as the source), DbList is split according to physical tables and generates multiple subtasks. The DbList of each subtask supports a maximum of 1 MB of data.

EtlOperatorColumnReference

String

No

{ "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" }

An operator that is related to the extract, transform, and load (ETL) feature and specific to T+1 business.

ModifyTypeEnum

String

No

UPDATE_RESERVED

Indicates the method to modify the synchronization task. If this parameter is not specified, the synchronization objects are modified by default. If this parameter is set to UPDATE_RESERVED, the reserved parameters are modified.

Reserved

String

No

{"definer": false,"syncArchitecture": "oneway","whitelist.dms.online.ddl.enable": false,"destSSL": "0","triggerMode": "manual","sqlparser.dms.original.ddl": true,"whitelist.ghost.online.ddl.enable": false,"privilegeMigration": false,"maxRetryTime": 43200,"srcSSL": "0","autoStartModulesAfterConfig": "none"}

The reserved parameter of DTS. The update method is to add rather than overwrite. The format is a MAP JSON string. You can pass this parameter to implement special requirements (such as whether to automatically start the precheck). The usage method is similar to the Reserve parameter. For more information, see Reserve parameter description.

FileOssUrl

String

No

http://db-list-os-file.oss-cn-shanghai.aliyuncs.com/8e42_12185******43989_************

The OSS URL of the synchronization file.

FilterTableName

String

No

testtable

The name of the table to be filtered.

StructureInitialization

Boolean

No

true

Specifies whether to perform schema migration or schema synchronization. Valid values:

• true: yes.

• false: no.

DataInitialization

Boolean

No

true

Specifies whether to perform full data migration or full data synchronization. Valid values:

• true: yes.

• false: no.

DataSynchronization

Boolean

No

true

Specifies whether to perform incremental data migration or incremental data synchronization. Valid values:

• false: no.

• true: yes.

DtsJobId

String

No

fpx1149rw7p***

The ID of the synchronization task. You can get it by calling the DescribeDtsJobs API.

ZeroEtlJob

Boolean

No

false

Specifies whether to query only zero-extract, transform, load (ETL) integration tasks. Valid values:

• true: yes.

• false: no.

ResourceGroupId

String

No

rg-acfmzawhxxc****

The ID of the resource group.

Status

String

200

The status code.

RequestId

String

1D6ECADF-C5E9-4C96-8811-77602B31****

The request ID.

DtsJobId

String

bi6e22a****

The DTS task ID.

ErrCode

String

InternalError

The error code returned when the request fails.

Success

Boolean

true

Indicates whether the request is successful.

ErrMessage

String

The request processing has failed due to some unknown error.

The error message returned if the request failed.