UpdateTask API參考-巨量資料開發治理平台 DataWorks-阿里雲 - DataWorks

更新指定任務。修改的內容會同步到資料開發，資料開發將新增一個儲存版本。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:*

update

*全部資源。

*

無

請求參數

名稱	類型	必填	描述	樣本值
Id	integer	是	任務 ID。	1234
ClientUniqueCode	string	否	任務的用戶端唯一碼，用來唯一標識一個任務。用於實現非同步和冪等，建立時如果不指定，系統將自動產生，該代碼將與資源 ID 進行唯一綁定。更新、刪除資源時如果指定該參數，應與建立時的用戶端唯一碼保持一致。	Task_0bc5213917368545132902xxxxxxxx
EnvType	string	否	專案環境。 Prod：生產 Dev：開發	Prod
Name	string	否	名稱。	SQL node
Description	string	否	描述資訊。	test
Owner	string	否	任務負責人的帳號 ID。	1000
InstanceMode	string	否	執行個體產生模式。 T+1（第二天產生） Immediately（立即產生）。注意：節點排程時間在節點發佈時間點十分鐘後的週期執行個體才會正常產生。全量轉執行個體期間（22:00~24:00 期間）不能進行即時轉執行個體，可以提交發佈節點，但新增節點不會自動轉出執行個體。	T+1
Timeout	integer	否	任務執行逾時時間，單位為秒。取值應大於 3600。	3600
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	否	任務觸發方式。
Type	string	否	觸發方式類型。 Scheduler：排程週期觸發 Manual：手動觸發	Scheduler
Recurrence	string	否	觸發時的執行模式，type=Scheduler 時生效。 Pause：暫停 Skip：空跑 Normal：正常執行	Normal
Cron	string	否	Cron 運算式，type=Scheduler 時生效。	00 00 00 * * ?
StartTime	string	否	週期觸發生效時間，type=Scheduler 時生效。格式為 `yyyy-mm-dd hh:mm:ss`	1970-01-01 00:00:00
EndTime	string	否	週期觸發失效時間，type=Scheduler 時生效。格式為 `yyyy-mm-dd hh:mm:ss`	9999-01-01 00:00:00
CycleType	string	否	週期類型，Type=Scheduler 且 Cron 運算式為指定某小時定時排程時生效。預設為 Daily。 Daily：指定為天排程 NotDaily：指定為小時排程	Daily
RuntimeResource	object	否	執行環境設定，如資源群組資訊。
ResourceGroupId	string	否	任務執行設定的排程資源群組識別碼。	S_res_group_524258031846018_1684XXXXXXXXX
Image	string	否	任務執行設定的映像 ID。	i-xxxxxx
Cu	string	否	任務執行設定 CU 消耗。	0.25
DataSource	object	否	關聯資料來源資訊。
Name	string	否	資料來源名稱。	odps_test
Inputs	object	否	輸入資訊。
Variables	array<object>	否	變數定義清單。
	object	否
Type	string	是	類型。 Constant：常數 PassThrough：參數節點輸出 System：變數 NodeOutput：指令碼輸出	Constant
Value	string	否	變數值。	value1
Name	string	否	變數名稱。	key1
Outputs	object	否	輸出資訊。
TaskOutputs	array<object>	否	任務輸出定義清單。
	object	否
Output	string	否	輸出識別碼。	pre.odps_sql_demo_0
Variables	array<object>	否	變數定義清單。
	object	否
Type	string	是	類型。 Constant：常數 PassThrough：參數節點輸出 System：變數 NodeOutput：指令碼輸出	Constant
Value	string	否	變數值。	value1
Name	string	否	變數名稱。	key1
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	否
Value	string	否	標籤值。	value1
Key	string	是	標籤鍵。	key1

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求的 ID，用於定位日誌，排查問題。	22C97E95-F023-56B5-8852-B1A77A17XXXX
Success	boolean	操作是否成功。	true

樣本

正常返回樣本

JSON格式

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "Success": true
}

錯誤碼

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

變更歷史

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