調用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
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。