Pauses a data migration task.

Note
  • If a data migration task is performing incremental data migration, we recommend that you do not pause the task for more than 6 hours. Otherwise, you will not be able to call the StartMigrationJob operation to restart the task.
  • If you select incremental data migration as the migration type for a pay-as-you-go instance, 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, incremental data migration consumes resources such as the bandwidth of the source database.

Debugging

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

Request parameters

Parameter Type Required Example Description
Action String Yes SuspendMigrationJob

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

MigrationJobId String Yes dtsj1x11y51g3b****

The ID of the data migration instance. You can call the DescribeMigrationJobs operation to query all data migration instances.

RegionId String No cn-hangzhou

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

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 ensure that it is unique among different requests. The ClientToken parameter can contain only ASCII characters and cannot exceed 64 characters in length.

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=SuspendMigrationJob
&SynchronizationJobId=dtsj1x11y51g3b****
&<Common request parameters>

Sample success responses

XML format

<SuspendMigrationJobResponse>
      <RequestId>C306C198-7807-409D-930A-D6CE6C32****</RequestId>
      <Success>true</Success>
</SuspendMigrationJobResponse>

JSON format

{
	"RequestId": "C306C198-7807-409D-930A-D6CE6C32****",
	"Success": true
}

Error codes

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