非同步產生同時任務的JSON。
介面說明
DataWorks 目前僅支援直接使用 CreateDISyncTask 介面建立Data Integration離線同步任務,而Data Integration即時同步任務和其他同步類型的任務則需要先調用 GenerateDISyncTaskConfigForCreating 和 QueryDISyncTaskConfigProcessResult 介面,擷取非同步產生建立Data Integration同步任務需要的參數,再將該參數作為 CreateDISyncTask 介面的入參,使用 CreateDISyncTask 介面建立相應的即時同步任務和其他同步類型的同步任務。 僅支援使用非同步方式建立Data Integration即時同步任務和其他同步類型的同步任務。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ProjectId |
integer |
是 |
DataWorks 工作空間的 ID。您可以登入 DataWorks 控制台,進入工作空間配置頁面擷取工作空間 ID。 該參數用來確定本次 API 呼叫操作使用的 DataWorks 工作空間。 |
10000 |
| TaskType |
string |
是 |
使用非同步方式建立Data Integration同步任務的任務類型。取值如下:
僅支援使用非同步方式產生Data Integration即時同步任務和其他同步類型的同步任務。 |
DI_REALTIME |
| TaskParam |
string |
是 |
Data Integration同步任務的指令碼。 目前支援建立的同步任務類型如下:
SelectedTables 用於多庫模式選擇同步表,Tables 用於單庫模式選擇同步表。
同步 MySQL 資料至 MaxCompute,樣本語句如下。
同步 MySQL 資料至 Kafka,樣本語句如下。
同步 MySQL 資料至 Hologres,樣本語句如下。 |
{ "type": "realtime", "version": "1.0", "setting": { "resourceGroup": "S_res_group_280749521950784_1623033752022", "taskType": "oneclick_to_odps" }, "steps": [{ "stepType": "mysql", "parameter": { "connection": [ { "datasourceType": "mysql", "datasource": "mysql_pub1", "selectedTables": [ { "dbName": "mysql_db", "schema": [ { "tableInfos": [ { "table": "molin_di_test_in_pk_v4" }] } ] } ] } ] }, "name": "Reader", "category": "reader" }, { "stepType": "odps", "parameter": { "datasource": "odps_source" }, "name": "Writer", "category": "writer" } ] } |
| ClientToken |
string |
否 |
等冪參數。用於避免多次調用導致操作重複。 |
ABFUOEUOTRTRJKE |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回結果。 |
||
| Success |
boolean |
請求是否成功。取值如下:
|
true |
| RequestId |
string |
請求 ID。用於定位日誌,排查問題。 |
0bc1411515937635973**** |
| Data |
object |
非同步線程 ID 的產生結果。 |
|
| Status |
string |
產生非同步線程 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. | 沒有許可權訪問 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。