調用CreateDISyncTask建立Data Integration同步任務-巨量資料開發治理平台 DataWorks-阿里雲 - DataWorks

介面說明

CreateDISyncTask 介面無法指定排程屬性，若想設定排程屬性，可使用 UpdataFile 介面。

調試

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

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:*

get

*全部資源。

*

無

請求參數

名稱	類型	必填	描述	樣本值
ProjectId	integer	是	DataWorks 工作空間的 ID。您可以登入 DataWorks 控制台，進入工作空間設定頁面取得工作空間 ID。	10000
TaskType	string	是	建立的資料整合同步任務的任務類型。目前支援使用 CreateDISyncTask 介面建立資料整合離線同步任務（DI_OFFLINE），即時同步任務（DI_REALTIME）和解決方案（DI_SOLUTION）。	DI_OFFLINE
TaskContent	string	是	資料整合同步任務的指令碼內容。	{"type":"job","version":"2.0","steps":[{"stepType":"mysql","parameter":{"envType":1,"datasource":"mysql_pub","column":["id","name","create_time","age","score","t_01"],"connection":[{"datasource":"mysql_pub","table":["u_pk"]}],"where":"","splitPk":"id","encoding":"UTF-8"},"name":"Reader","category":"reader"},{"stepType":"odps","parameter":{"partition":"pt=${bizdate}","truncate":true,"datasource":"odps_first","envType":1,"column":["id","name","create_time","age","score","t_01"],"emptyAsNull":false,"tableComment":"null","table":"u_pk"},"name":"Writer","category":"writer"}],"setting":{"executeMode":null,"errorLimit":{"record":""},"speed":{"concurrent":2,"throttle":false}},"order":{"hops":[{"from":"Reader","to":"Writer"}]}}
TaskParam	string	否	資料整合同步任務的設定參數。目前支援設定如下參數： FileFolderPath：表示資料整合同步任務的存放路徑。 ResourceGroup：表示資料整合同步任務所使用的資料整合資源群組識別碼（Identifier）。您可以呼叫 ListResourceGroups ，取得資源群組識別碼。 Cu：表示資料整合同步任務在 Serverless 資源群組上佔用的規格，必須是 0.5 的倍數。建立離線同步任務（TaskType=DI_OFFLINE）時，此參數實際為必填項，並且至少需要包含 FileFolderPath。	{"FileFolderPath":"業務流程/XXX/資料整合","ResourceGroup":"Serverless_res_group_XXX_XXXX", "Cu":1.5}
TaskName	string	否	建立的資料整合同步任務的名稱。	new_di_task
ClientToken	string	否	冪等參數，該參數可為空。	0000-ABCD-EFG****

返回參數

名稱	類型	描述	樣本值
	object
Success	boolean	請求是否成功。	true
RequestId	string	請求 ID。用於定位日誌，排查問題。	0bc1411515937635973****
Data	object	建立資料整合同步任務的傳回結果。
Status	string	建立資料整合同步任務的結果狀態。取值如下： success：表示建立任務成功。 fail：表示建立任務失敗。	success
Message	string	建立資料整合同步任務失敗的原因描述，如果成功，該欄位為空，如果不成功，範例如下「不合法的目錄路徑：業務流程/xxxx/資料整合」。	不合法的目錄路徑：業務流程/xxxx/資料整合
FileId	integer	成功建立的資料整合同步任務的任務 ID。	1000001

樣本

正常返回樣本

JSON格式

{
  "Success": true,
  "RequestId": "0bc1411515937635973****",
  "Data": {
    "Status": "success",
    "Message": "Invalid directory path: workflow/xxxx/data integration.",
    "FileId": 1000001
  }
}

錯誤碼

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.	資料整合內部業務錯誤。
403	Forbidden.DI.NoPrivilege	No access.	沒有權限存取。

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

變更歷史

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