调用SuspendSynchronizationJob接口暂停处于同步中的数据同步实例。

说明
  • 调用本接口时，同步作业须处于同步中状态。
  • 暂停同步作业不能超过6个小时，否则将无法被再次启动。
  • 按量付费类型的同步作业即使处于暂停状态，DTS依然会收取费用。这是由于DTS只是暂停向目标库写入数据，仍然会继续拉取源库的日志以便重启任务后快速恢复运行，因此还是会占用源数据库的带宽等资源。

调试

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

请求参数

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

系统规定参数，取值：SuspendSynchronizationJob。

SynchronizationJobId String 是 dtsmr1q4mc2152****

数据同步实例ID，可以通过调用DescribeSynchronizationJobs接口查询。

RegionId String 否 cn-hangzhou

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

SynchronizationDirection String 否 Forward

同步方向，取值：

  • Forward：正向。
  • Reverse：反向。
说明
  • 默认取值为Forward。
  • 当数据同步实例的拓扑为双向时，才可以传入Reverse以暂停反向同步链路。
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=SuspendSynchronizationJob
&SynchronizationJobId=dtsmr1q4mc2152****
&<公共请求参数>

正常返回示例

XML格式 

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

JSON格式 

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

错误码

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