文档

修改DTS订阅任务

更新时间:

调用ModifySubscription接口修改DTS订阅任务的订阅对象及订阅数据的类型。

您可以在控制台的高级配置阶段,将鼠标光标移动至下一步保存任务并预检查按钮上,然后单击气泡中的预览OpenAPI参数,查看该实例使用API接口配置时的参数信息。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String ModifySubscription

系统规定参数。取值:ModifySubscription

RegionId String cn-hangzhou

DTS实例所在地域,请参见查询DTS的IP地址

DtsInstanceId String dtsboss6pn1w******

订阅实例ID,可以调用DescribeDtsJobs查询。

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

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

说明
  • 原DbList会被新传入的DbList覆盖,请确保新传入的DbList数据中包含所有需要订阅的对象,否则可能会导致订阅对象丢失,请谨慎修改。
  • 原订阅对象,可调用DescribeDtsJobDetail进行查询。
DtsJobId String boss6pn1w******

订阅任务ID,可以调用DescribeDtsJobs查询。

SubscriptionDataTypeDDL Boolean true

修改后任务是否订阅DDL类型的数据,取值:

  • true:是。
  • false:否。
SubscriptionDataTypeDML Boolean true

修改后任务是否订阅DML类型的数据,取值:

  • true:是。
  • false:否。

返回数据

名称

类型

示例值

描述

HttpStatusCode String 200

状态码。

RequestId String 068FA72F-4800-4A54-90BB-94806068****

请求ID。

ErrCode String InternalError

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

Success String true

请求是否成功。

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

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

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=ModifySubscription
&DbList={"dtstest":{"name":"dtstest","all":true}}
&DtsInstanceId=dtsboss6pn1w******
&DtsJobId=boss6pn1w******
&SubscriptionDataTypeDDL=true
&SubscriptionDataTypeDML=true

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifySubscriptionResponse>
    <RequestId>068FA72F-4800-4A54-90BB-94806068****</RequestId>
    <HttpStatusCode>200</HttpStatusCode>
    <Success>true</Success>
</ModifySubscriptionResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "068FA72F-4800-4A54-90BB-94806068****",
  "HttpStatusCode" : 200,
  "Success" : true
}

错误码

HttpCode

错误码

错误信息

描述

400 Throttling.User Request was denied due to user flow control. 由于请求频次达到阈值,请求被拒绝,请稍后重试。
500 ServiceUnavailable The request has failed due to a temporary failure of the server. 由于服务端响应超时或者不可用导致请求失败,请重试,重试后仍失败请联系技术支持。
403 InvalidSecurityToken.Expired Specified SecurityToken is expired. 签名已经过期,请更新签名

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

  • 本页导读 (1)
文档反馈