Modifies the settings of a data synchronization task.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer automatically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ModifyDtsJob

The operation that you want to perform. Set the value to ModifyDtsJob.

DtsInstanceId String Yes dtsbi6e22ay243****

The ID of the data synchronization instance.

RegionId String No cn-hangzhou

The ID of the region where the data synchronization instance resides. For more information, see List of supported regions.

SynchronizationDirection String No Forward

The synchronization direction. Valid values:

  • Forward
  • Reverse
Note
  • Default value: Forward.
  • This parameter is required only when the topology of the data synchronization instance is two-way synchronization.
ClientToken String No 0c593ea1-3bea-11e9-b96b-88e9fe63****

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The ClientToken parameter can contain only ASCII characters and cannot exceed 64 characters in length.

DbList Json No {"dtstest":{"name":"dtstest","all":true}}

The objects of the data synchronization task. The value is a JSON string. For more information, see Objects of DTS tasks.

Note Before you call the ModifyDtsJob operation, we recommend that you call the DescribeDtsJobDetail to query the current objects of the data synchronization task. Then, you can specify the new objects based on your business needs. For example, if the current objects are Table A and Table B, and you need to add Table C, you must set this parameter to Table A, Table B, and Table C.

Response parameters

Parameter Type Example Description
DtsJobId String bi6e22a****

The ID of the DTS task.

ErrCode String InternalError

The error code returned if the call failed.

ErrMessage Boolean true

The error message returned if the call failed.

Note The data type of this parameter is String. The actual sample value is The request processing has failed due to some unknown error.
RequestId String 1D6ECADF-C5E9-4C96-8811-77602B31****

The ID of the request.

Status String 200

The HTTP status code.

Success Boolean true

Indicates whether the call was successful.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=ModifyDtsJob
&DtsInstanceId=dtsbi6e22ay243****
&DbList={"dtstest":{"name":"dtstest","all":true}}
&<Common request parameters>

Sample success responses

XML format

<ModifyDtsJobResponse>
      <DtsJobId>bi6e22a****</DtsJobId>
      <RequestId>1D6ECADF-C5E9-4C96-8811-77602B31****</RequestId>
      <Success>true</Success>
</ModifyDtsJobResponse>

JSON format

{
    "DtsJobId":"bi6e22a****",
    "RequestId":"1D6ECADF-C5E9-4C96-8811-77602B31****",
    "Success":true
}

Error codes

For a list of error codes, visit the API Error Center.