使用UpdateDISyncTask API更新Data Integration同步任務-巨量資料開發治理平台 DataWorks-阿里雲

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:*

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
ProjectId	integer	是	DataWorks 工作空間的 ID。您可以登入 DataWorks 控制台，進入工作空間配置頁面擷取工作空間 ID。該參數用來確定本次 API 呼叫操作使用的 DataWorks 工作空間。	10000
TaskType	string	是	修改的Data Integration同步任務的任務類型。目前僅支援使用 UpdateDISyncTask 介面修改Data Integration離線同步任務（DI_OFFLINE）。	DI_OFFLINE
TaskContent	string	否	更新已建立的Data Integration同步任務通過指令碼模式配置的任務內容。詳情請參見通過指令碼模式配置任務。當前僅支援通過 UpdateDISyncTask 介面更新Data Integration離線同步任務。如果您無需更新Data Integration同步任務的配置內容，則可將該參數置為空白。	{"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_source","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	否	更新Data Integration同步任務的配置參數，使用 JSON 格式。 ResourceGroup：表示Data Integration同步任務所使用的Data Integration資源群組標識（Identifier）。您可以調用 ListResourceGroups ，擷取資源群組標識。 Cu：表示Data Integration同步任務在 Serverless 資源群組上佔用的規格，必須是 0.5 的倍數。	{"ResourceGroup":"Serverless_res_group_XXX_XXXX", "Cu":1.5}
FileId	integer	是	需要更新的Data Integration同步任務的任務 ID。您可以調用 ListFiles 介面擷取同步任務的 ID。	1000000

返回參數

名稱	類型	描述	樣本值
	object	返回資料。
Success	boolean	請求是否成功。取值如下： true：成功。 false：失敗。	true
RequestId	string	請求 ID。用於定位日誌，排查問題。	0bc1411515937635973****
Data	object	更新Data Integration同步任務的返回結果。
Status	string	更新Data Integration同步任務的結果狀態。取值如下： success：表示更新Data Integration同步任務成功。 fail：表示更新Data Integration同步任務失敗。	success
Message	string	更新Data Integration同步任務失敗後的原因描述。如果更新Data Integration同步任務成功，則該參數的傳回值為空白。	ResourceGroup:[S_res_group_XXX] is invalid.

樣本

正常返回樣本

JSON格式

{
  "Success": true,
  "RequestId": "0bc1411515937635973****",
  "Data": {
    "Status": "success",
    "Message": "ResourceGroup:[S_res_group_XXX] is invalid."
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	Invalid.DI.Parameter	The parameter is invalid.	參數錯誤
500	InternalError.DI.Parameter	A DI internal error occurred.	Data Integration內部業務錯誤
403	Forbidden.DI.NoPrivilege	No access.	沒有許可權訪問

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

變更歷史

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