調用GenerateDISyncTaskConfigForUpdating非同步產生更新即時同步任務所需配置-巨量資料開發治理平台 DataWorks-阿里雲

介面說明

DataWorks 目前僅支援直接使用 UpdateDISyncTask 介面更新Data Integration離線同步任務，而Data Integration即時同步任務則需要先調用 GenerateDISyncTaskConfigForUpdating 和 QueryDISyncTaskConfigProcessResult 介面，非同步產生更新Data Integration同步任務需要的參數，再將該參數作為 UpdateDISyncTask 介面的入參，使用 UpdateDISyncTask 介面更新相應的即時同步任務。僅支援使用非同步方式更新Data Integration即時同步任務。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
ProjectId	integer	是	DataWorks 工作空間的 ID。您可以登入 DataWorks 控制台，進入工作空間配置頁面擷取工作空間 ID。該參數用來確定本次 API 呼叫操作使用的 DataWorks 工作空間。	10000
TaskType	string	是	使用非同步方式更新Data Integration同步任務的任務類型。取值如下： DI_REALTIME：表示即時同步任務。 DI_SOLUTION：表示解決方案同步任務。僅支援使用非同步方式更新Data Integration即時同步任務和解決方案同步任務。	DI_REALTIME
TaskParam	string	是	更新同步任務的指令碼語句。目前僅支援通過非同步方式為Data Integration同步任務新增表或者刪除表，並且僅支援更新如下類型的同步任務：同步 MySQL 資料至 MaxCompute。同步 MySQL 資料至 Kafka。同步 MySQL 資料至 Hologres。同步任務中的 SelectedTables 用於多庫模式選擇同步表，Tables 用於單庫模式選擇同步表。當指令碼中包含 SelectedTables 語句時，系統會使用 SelectedTables 語句中的表資訊進行同步。當指令碼中包含 Tables 語句時，系統會使用 Tables 的欄位資訊進行同步。	{"steps":[{"parameter":{"connection":[{"table":["xyx"]}]},"name":"Reader","category":"reader"}]}
ClientToken	string	否	等冪參數。用於避免多次調用導致操作重複。	ABFUOEUOTRTRJKE
TaskId	integer	是	任務 ID。當 TaskType 參數配置為即時同步任務（DI_REALTIME），則 TaskId 為即時同步任務的 FileId。當 TaskType 參數配置為解決方案同步任務（DI_SOLUTION），則 TaskId 為解決方案同步任務的 FileId。	100

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
Success	boolean	請求是否成功。取值如下： true：成功。 false：失敗。	true
RequestId	string	請求 ID。用於定位日誌，排查問題。	0bc1411515937635973****
Data	object	非同步線程 ID 的產生結果。
Status	string	產生非同步線程 ID 的結果狀態。取值如下： success：表示成功產生非同步線程 ID。 fail：表示非同步線程 ID 產生失敗。您可以查看失敗原因，處理相關問題。	true
ProcessId	integer	非同步線程 ID。您需要通過該 ID，調用 QueryDISyncTaskConfigProcessResult 介面擷取非同步產生更新Data Integration同步任務需要的參數，後續使用該參數更新Data Integration同步任務。	10
Message	string	非同步線程 ID 產生失敗的原因描述。如果成功產生非同步線程 ID，則該參數的傳回值為空白。	XXX is invalid.

樣本

正常返回樣本

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.	參數不合法，檔案名稱已存在
500	InternalError.DI.Parameter	A DI internal error occurred.	Data Integration內部業務錯誤
403	Forbidden.DI.NoPrivilege	No access.	沒有許可權訪問

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。