Pauses a data synchronization task.
- When you call this operation, the data synchronization task must be in the Synchronizing state.
- We recommend that you do not pause a data synchronization task for more than 6 hours. Otherwise, the task cannot be started again.
- If the billing method is pay-as-you-go, DTS charges a fee even when the task is paused. This is because DTS only stops writing data to the destination database. DTS continues to pull the logs of the source database so that the task can resume quickly after it is restarted. Therefore, data synchronization consumes resources such as the bandwidth of the source database.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | SuspendSynchronizationJob |
The operation that you want to perform. Set the value to SuspendSynchronizationJob. |
SynchronizationJobId | String | Yes | dtsmr1q4mc2152**** |
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:
Note
|
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 | C306C198-7807-409D-930A-D6CE6C32**** |
The ID of the request. |
Success | String | true |
Indicates whether the call was successful. |
Examples
Sample requests
http(s)://dts.aliyuncs.com/?Action=SuspendSynchronizationJob
&SynchronizationJobId=dtsmr1q4mc2152****
&<Common request parameters>
Sample responses
XML
format
<SuspendSynchronizationJobResponse>
<RequestId>C306C198-7807-409D-930A-D6CE6C32****</RequestId>
<Success>true</Success>
</SuspendSynchronizationJobResponse>
JSON
format
{
"RequestId": "C306C198-7807-409D-930A-D6CE6C32****",
"Success": true
}
Error codes
For a list of error codes, visit the API Error Center.