调用ModifySubscriptionObject接口修改订阅对象。
调用本接口时,订阅通道需处于正常、未启动或启动失败状态。
说明
- 当订阅通道处于为正常状态时,成功调用本接口修改订阅对象后,DTS将自动调用StartSubscriptionInstance重启订阅通道。
- 当订阅通道处于未启动或启动失败状态时,成功调用本接口修改订阅对象后,DTS不会自动启动订阅通道,您需要手动调用StartSubscriptionInstance重启订阅通道。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ModifySubscriptionObject |
系统规定参数,取值:ModifySubscriptionObject。 |
SubscriptionInstanceId | String | 是 | dtsl8zl9ek6292**** |
数据订阅实例ID,可以通过调用DescribeSubscriptionInstances接口查询。 |
SubscriptionObject | String | 是 | [{"DBName":"dtstestdata"}] |
订阅对象,格式为JSON串且支持一定的正则表达式,详细说明请参见订阅对象配置说明。 |
RegionId | String | 否 | cn-hangzhou |
地域ID,传入本参数来指定实例所在地域,详情请参见支持的地域列表。 |
AccountId | String | 否 | 12323344**** |
阿里云主账号ID,无需设置,该参数即将下线。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ErrCode | String | InternalError |
调用出错时返回的错误码。 |
ErrMessage | String | The request processing has failed due to some unknown error. |
调用出错时返回的错误信息。 |
RequestId | String | ABBACEFC-CBA9-4F80-A337-42F202F5**** |
请求ID。 |
Success | String | true |
请求是否成功。 |
示例
请求示例
http(s)://dts.aliyuncs.com/?Action=ModifySubscriptionObject
&SubscriptionInstanceId=dtsl8zl9ek6292****
&SubscriptionObject=[{"DBName":"dtstestdata"}]
&<公共请求参数>
正常返回示例
XML
格式
<ModifySubscriptionObjectResponse>
<RequestId>ABBACEFC-CBA9-4F80-A337-42F202F5****</RequestId>
<Success>true</Success>
</ModifySubscriptionObjectResponse>
JSON
格式
{
"RequestId": "ABBACEFC-CBA9-4F80-A337-42F202F5****",
"Success": true
}
错误码
访问错误中心查看更多错误码。