異步生成更新同步任務的JSON。
接口說明
DataWorks 目前僅支持直接使用 UpdateDISyncTask 接口更新數據集成離線同步任務,而數據集成實時同步任務則需要先調用 GenerateDISyncTaskConfigForUpdating 和 QueryDISyncTaskConfigProcessResult 接口,異步生成更新數據集成同步任務需要的參數,再將該參數作為 UpdateDISyncTask 接口的入參,使用 UpdateDISyncTask 接口更新相應的實時同步任務。 僅支持使用異步方式更新數據集成實時同步任務。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ProjectId | long | 是 | DataWorks 工作空間的 ID。您可以登錄 DataWorks 控制臺,進入工作空間配置頁面獲取工作空間 ID。 該參數用來確定本次 API 調用操作使用的 DataWorks 工作空間。 | 10000 |
TaskType | string | 是 | 使用異步方式更新數據集成同步任務的任務類型。取值如下:
| DI_REALTIME |
TaskParam | string | 是 | 更新同步任務的腳本語句。 目前僅支持通過異步方式為數據集成同步任務新增表或者刪除表,并且僅支持更新如下類型的同步任務:
同步任務中的 SelectedTables 用于多庫模式選擇同步表,Tables 用于單庫模式選擇同步表。
| {"steps":[{"parameter":{"connection":[{"table":["xyx"]}]},"name":"Reader","category":"reader"}]} |
ClientToken | string | 否 | 冪等參數。用于避免多次調用導致操作重復。 | ABFUOEUOTRTRJKE |
TaskId | long | 是 | 任務 ID。
| 100 |
返回參數
示例
正常返回示例
JSON
格式
{
"Success": true,
"RequestId": "0bc1411515937635973****",
"Data": {
"Status": "true",
"ProcessId": 10,
"Message": "XXX is invalid."
}
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | Invalid.DI.Parameter | The parameter is invalid. | 參數錯誤 |
400 | Invalid.DI.Parameter.File.Existed | The file name already exists. | 參數不合法,文件名已存在 |
403 | Forbidden.DI.NoPrivilege | No access. | 沒有權限訪問 |
500 | InternalError.DI.Parameter | A DI internal error occurred. | 數據集成內部業務錯誤 |
訪問錯誤中心查看更多錯誤碼。