调用SuspendMigrationJob接口暂停处于迁移中的数据迁移任务。

说明
  • 如果数据迁移任务已进入增量数据迁移阶段,请勿将迁移任务暂停超过6个小时,否则将无法调用StartMigrationJob接口重启该任务。
  • 如果按量付费的数据迁移任务配置了增量迁移 ,即使处于暂停状态,DTS依然会收取费用。这是由于DTS只是暂停向目标库写入数据,仍然会继续拉取源库的日志以便重启任务后快速恢复运行,因此还是会占用源数据库的带宽等资源。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String SuspendMigrationJob

系统规定参数,取值:SuspendMigrationJob

MigrationJobId String dtsj1x11y51g3b****

数据迁移实例ID,可以通过调用DescribeMigrationJobs接口查询。

RegionId String cn-hangzhou

地域ID,传入本参数来指定实例所在地域,详情请参见支持的地域列表

ClientToken String 0c593ea1-3bea-11e9-b96b-88e9fe63****

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。

AccountId String 12323344****

阿里云主账号ID,无需设置,该参数即将下线。

返回数据

名称 类型 示例值 描述
ErrCode String InternalError

调用出错时返回的错误码。

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

调用错误时返回对应的错误信息。

RequestId String C306C198-7807-409D-930A-D6CE6C32****

请求ID。

Success String true

请求是否成功。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=SuspendMigrationJob
&SynchronizationJobId=dtsj1x11y51g3b****
&<公共请求参数>

正常返回示例

XML 格式

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

JSON 格式

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

错误码

访问错误中心查看更多错误码。