UpdateTaskAsync - DataWorks

非同步更新指定任務，並同步到資料開發新增儲存版本。

介面說明

請求說明

該 API 為非同步介面，需要搭配 GetUpdateTaskResult 介面輪詢更新結果。
該 API 用於更新指定的任務資訊，包括但不限於任務名稱、描述、責任人等。
修改的內容會同步到資料開發，並且資料開發將新增一個儲存版本。
支援設定任務的觸發方式、執行環境配置以及依賴關係等詳細參數。

調試

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

調試

授權資訊

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

請求文法

POST  HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
Id	integer	是	任務 ID。	10001
ClientUniqueCode	string	否	任務的用戶端唯一碼，用來唯一標識一個任務。用於實現非同步和冪等，建立時如果不指定，系統將自動產生，該代碼將與資源 ID 進行唯一綁定。更新、刪除資源時如果指定該參數，應與建立時的用戶端唯一碼保持統一。	Workflow_0bc5213917368545132902xxxxxxxx
EnvType	string	否	專案環境。 Prod：生產 Dev：開發	Prod
Name	string	否	名稱。	name
Description	string	否	描述。	This is a description.
Owner	string	否	任務的責任人的帳號 ID。您可以登入 DataWorks 控制台，滑鼠懸停至頂部選單列右側的使用者頭像，檢視帳號 ID。如果該參數為空，則預設使用呼叫者的阿里雲帳號 ID。	1000000000001
InstanceMode	string	否	執行個體產生模式。 T+1（第二天產生） Immediately（立即產生）。注意：節點排程時間在節點發佈時間點十分鐘後的週期執行個體才會正常產生。全量轉執行個體期間（22:00~24:00 點期間）不能進行即時轉執行個體，可以提交發佈節點，但新增節點不會自動轉出執行個體。	T+1
Timeout	integer	否	排程配置逾時定義。	1
RerunMode	string	否	任務是否允許重跑的配置。 AllDenied：失敗或成功都不可重跑 FailureAllowed：只有失敗可重跑 AllAllowed：失敗或成功均可重跑	AllAllowed
RerunTimes	integer	否	重試次數，當任務設定為可重跑時生效。	3
RerunInterval	integer	否	重試時間間隔，單位毫秒。（不得超過 1800000）	60000
Script	object	否	執行指令碼資訊。
Content `deprecated`	string	否	指令碼內容。	echo "helloWorld"
Parameters	string	否	指令碼參數清單。	para1=$bizdate
Trigger	object	否	任務觸發方式。
Cron	string	否	Cron 運算式，type=Scheduler 時生效。	00 00 00 * * ?
CycleType	string	否	週期類型，Type=Scheduler 且 Cron 運算式為指定某小時排程時生效。預設為 Daily。 Daily：指定為天排程 NotDaily：指定為小時排程	Daily
EndTime	string	否	週期觸發失效時間，type=Scheduler 時生效。格式為 `yyyy-mm-dd hh:mm:ss`	9999-01-01 00:00:00
Recurrence	string	否	觸發時的執行模式，type=Scheduler 時生效。 Pause：暫停 Skip：空跑 Normal：正常執行	Normal
StartTime	string	否	週期觸發生效時間，type=Scheduler 時生效。格式為 `yyyy-mm-dd hh:mm:ss`	1970-01-01 00:00:00
Type	string	否	觸發方式類型。 Scheduler：排程週期觸發 Manual：手動觸發	BySchedule
RuntimeResource	object	否	執行環境配置，如資源群組資訊。
Cu	string	否	任務執行配置 CU 消耗。	0.25
Image	string	否	任務執行配置的映像 ID。	i-xxxxxx
ResourceGroupId	string	否	任務執行配置的排程資源群組識別碼。	63900680
DataSource	object	否	關聯資料來源資訊。
Name	string	否	資料來源名稱。	odps_test
Inputs	object	否	輸入資訊。
Variables	array<object>	否	變數定義清單。
	object	否	變數定義清單。
Name	string	否	變數名稱。	key1
Type	string	是	類型。 Constant：常數 PassThrough：參數節點輸出 System：變數 NodeOutput：指令碼輸出	Constant
Value	string	否	變數值。	value1
Outputs	object	否	輸出資訊。
TaskOutputs	array<object>	否	任務輸出定義清單。
	object	否	任務輸出定義清單。
Output	string	否	輸出識別碼。	pre.odps_sql_demo_0
Variables	array<object>	否	變數定義清單。
	object	否	變數定義清單。
Name	string	否	變數名稱。	key1
Type	string	是	類型。 Constant：常數 PassThrough：參數節點輸出 System：變數 NodeOutput：指令碼輸出	Constant
Value	string	否	變數值。	value1
Dependencies	array<object>	否	依賴資訊。
	object	否	依賴資訊。
Type	string	是	依賴類型。 CrossCycleDependsOnChildren：跨週期依賴一層子節點 CrossCycleDependsOnSelf：跨週期依賴自己 CrossCycleDependsOnOtherNode：跨週期依賴其他節點 Normal：同週期依賴	Normal
UpstreamOutput	string	否	上游任務的輸出識別碼。（同週期依賴且設定 input 內容時，傳回此欄位）	pre.odps_sql_demo_0
UpstreamTaskId	integer	否	上游任務的 ID。（`跨週期依賴其他節點`與`同週期依賴`未設定 input 內容時，傳回此欄位，其他情況不傳回）	1234
Tags	array<object>	否	待綁定的資料資產標籤清單。
	object	否	任務標籤清單。
Key	string	是	標籤鍵。	tagKey
Value	string	否	標籤值。	value

返回參數

名稱	類型	描述	樣本值
	object
OperationId	string	操作 ID，用於非同步更新任務的結果，可透過 `UpdateTaskAsync` 介面取得。	e15ad21c-b0e9-4792-8f55-b037xxxxxxxx
RequestId	string	本次呼叫的唯一 ID。出現錯誤後，您可以根據該 ID 排查問題。	10000001

樣本

正常返回樣本

JSON格式

{
  "OperationId": "e15ad21c-b0e9-4792-8f55-b037xxxxxxxx",
  "RequestId": "10000001"
}

錯誤碼

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

變更歷史

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