Clears the configurations of a data synchronization task.

Note If you clear the configurations of a data synchronization task, the task will be released. To start the task again, you must call the ConfigureSynchronizationJob operation to reconfigure the 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 ResetSynchronizationJob

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

SynchronizationJobId String Yes dtsm761239l27m****

The ID of the data synchronization instance. You can call the DescribeSynchronizationJobs operation to query the instance ID.

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.
  • You can set this parameter to Reverse to stop reverse synchronization only when the topology 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 FDC111B1-ACBF-457D-9656-247FDEE9****

The ID of the request.

Success String true

Indicates whether the call was successful.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=ResetSynchronizationJob
&SynchronizationJobId=dtsm761239l27m****
&<Common request parameters>

Sample success responses

XML format

<ResetSynchronizationJobResponse>
      <RequestId>FDC111B1-ACBF-457D-9656-247FDEE9****</RequestId>
      <Success>true</Success>
</ResetSynchronizationJobResponse>

JSON format

{
	"RequestId": "FDC111B1-ACBF-457D-9656-247FDEE9****",
	"Success": true
}

Error codes

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