Modifies the objects to be synchronized.

Note When you call this operation, the data synchronization task must be in the Not Started or Synchronizing state.

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 ModifySynchronizationObject

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

SynchronizationJobId String Yes dtskfq1149w254****

The ID of the data synchronization instance. You can call the DescribeSynchronizationJobs operation to query the instance ID.
SynchronizationObjects String Yes [{"DBName": "dtstestdata"}]

The objects that you want to synchronize. The value is a JSON string and can contain regular expressions. For more information, see SynchronizationObjects.

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.
AccountId String No 12323344****

The ID of the Alibaba Cloud account. You do not need to specify this parameter because this parameter will be removed in the future.

Response parameters

Parameter Type Example Description
ErrCode String InternalError

The error code returned if the call failed.

ErrMessage String The request processing has failed due to some unknown error.

The error message returned if the call failed.

RequestId String 902DDCDE-C755-4458-85DA-DF9A323C****

The ID of the request.

Success String true

Indicates whether the call was successful.

TaskId String tl911uvi25z****

The ID of the task that changes the objects. You must specify the task ID when you call the DescribeSynchronizationObjectModifyStatus operation to query the status and progress of the task.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=ModifySynchronizationObject
&SynchronizationJobId=dtskfq1149w254****
&SynchronizationObjects=[{"DBName": "dtstestdata"}]
&<Common request parameters>

Sample responses

XML format 

<ModifySynchronizationObjectResponse>
      <TaskId>tl911uvi25z****</TaskId>
      <RequestId>902DDCDE-C755-4458-85DA-DF9A323C****</RequestId>
      <Success>true</Success>
</ModifySynchronizationObjectResponse>

JSON format 

{
    "TaskId": "tl911uvi25z****",
    "RequestId": "902DDCDE-C755-4458-85DA-DF9A323C****",
    "Success": true
}

Error codes

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