调用ModifyDtsJob接口修改迁移、同步或订阅任务。

调试

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

请求参数

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

系统规定参数。取值:ModifyDtsJob

DtsInstanceId String dtsbi6e22ay243****

迁移、同步或订阅实例ID。

RegionId String cn-hangzhou

实例所在区域,详情请参见支持的地域列表

SynchronizationDirection String Forward

指定同步方向,取值:

  • Forward:正向。
  • Reverse:反向。
说明
  • 默认取值为Forward
  • 只有当数据同步实例的同步拓扑为双向同步时,才需要传入本参数。
ClientToken String 0c593ea1-3bea-11e9-b96b-88e9fe63****

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

DbList Json {"dtstest":{"name":"dtstest","all":true}}

修改后的迁移、同步或订阅对象,格式为JSON串。详细定义,请参见迁移、同步或订阅对象说明

说明 建议您提前调用DescribeDtsJobDetail查询当前迁移、同步或订阅对象,然后根据业务需要输入修改后的迁移、同步或订阅对象对象。例如,当前对象为表A、B,现需要新增对象表C,那么您需要在本参数同时传入表A、B、C。

返回数据

名称 类型 示例值 描述
DtsJobId String bi6e22a****

DTS任务ID。

ErrCode String InternalError

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

ErrMessage Boolean true

调用出错时返回的错误信息。

说明 该参数的数据类型应为String,实际示例值为The request processing has failed due to some unknown error.
RequestId String 1D6ECADF-C5E9-4C96-8811-77602B31****

请求ID。

Status String 200

状态码。

Success Boolean true

请求是否成功。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=ModifyDtsJob
&DtsInstanceId=dtsbi6e22ay243****
&DbList={"dtstest":{"name":"dtstest","all":true}}
&<公共请求参数>

正常返回示例

XML格式

<ModifyDtsJobResponse>
      <DtsJobId>bi6e22a****</DtsJobId>
      <RequestId>1D6ECADF-C5E9-4C96-8811-77602B31****</RequestId>
      <Success>true</Success>
</ModifyDtsJobResponse>

JSON格式

{
    "DtsJobId":"bi6e22a****",
    "RequestId":"1D6ECADF-C5E9-4C96-8811-77602B31****",
    "Success":true
}

错误码

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