調用ModifySubscriptionObject介面修改訂閱對象。
調用本介面時,訂閱通道需處於正常、未啟動或啟動失敗狀態。
說明
- 當訂閱通道處於為正常狀態時,成功調用本介面修改訂閱對象後,DTS將自動調用StartSubscriptionInstance重啟訂閱通道。
- 當訂閱通道處於未啟動或啟動失敗狀態時,成功調用本介面修改訂閱對象後,DTS不會自動啟動訂閱通道,您需要手動調用StartSubscriptionInstance重啟訂閱通道。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
請求參數
| 名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
| Action | String | 是 | ModifySubscriptionObject | 系統規定參數,取值:ModifySubscriptionObject。 |
| SubscriptionInstanceId | String | 是 | dtsl8zl9ek6292**** | 資料訂閱執行個體ID,可以通過調用DescribeSubscriptionInstances介面查詢。 |
| SubscriptionObject | String | 是 | [{"DBName":"dtstestdata"}] | 訂閱對象,格式為JSON串且支援一定的Regex,詳細說明請參見訂閱對象配置說明。 |
| 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
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。