調用UpdateWorkflow API全量更新工作流程-巨量資料開發治理平台 DataWorks-阿里雲 -

以全量更新的方式，更新指定工作流程。支援同步更新到資料開發的欄位：負責人、資料來源、排程資源群組、描述資訊、觸發執行模式（正常、空跑、暫停）。

介面說明

需要購買 DataWorks 基礎版及以上版本才能使用。

調試

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

調試

授權資訊

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

請求參數

名稱	類型	必填	描述	樣本值
Id	integer	是	工作流程 ID。	1234
EnvType	string	否	專案環境。 Prod：生產 Dev：開發	Prod
Name	string	是	名稱。	My Workflow
Owner	string	是	負責人的帳號 ID。	1000
Trigger	object	是	觸發方式。
Type	string	是	觸發方式類型。 Scheduler：排程週期觸發 Manual：手動觸發	Scheduler
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
Description	string	否	描述資訊。	test
Dependencies	array<object>	否	相依性資訊。
	object	否
Type	string	是	相依性類型。 CrossCycleDependsOnChildren：跨週期相依一級子節點 CrossCycleDependsOnSelf：跨週期相依自身 CrossCycleDependsOnOtherNode：跨週期相依其他節點 Normal：同週期相依	Normal
UpstreamOutput	string	否	上游任務的輸出識別碼。（`同週期相依`且設定 input 內容時，返回此欄位）	pre.odps_sql_demo_0
UpstreamTaskId	integer	否	上游任務的 Id。（`跨週期相依其他節點`與`同週期相依`未設定 input 內容時，返回此欄位，其他情況不返回）	1234
Parameters	string	否	參數清單。	para1=$bizdate para2=$[yyyymmdd]
Tasks	array<object>	否	任務清單。
	array<object>	否
Id	integer	否	任務 ID。填寫此欄位會對相應任務執行全量更新，未填寫此欄位則會建立新任務。	1234
Name	string	是	任務的名稱。	SQL node
Description	string	否	描述資訊。	Test
Type	string	是	任務類型。	ODPS_SQL
Owner	string	是	負責人的帳號 ID。	1000
BaseLineId	integer	否	基線 ID。	1234
Timeout	integer	否	任務執行逾時時間，單位秒。	3600
RerunMode	string	是	任務是否允許重跑的設定。 AllDenied：失敗或成功都不可重跑 FailureAllowed：只有失敗可重跑 AllAllowed：失敗或成功均可重跑	AllAllowed
RerunTimes	integer	否	重試次數，當任務設定為可重跑時生效。	3
RerunInterval	integer	否	重試時間間隔，單位秒。	60
Script	object	否	執行指令碼資訊。
Content	string	否	指令碼內容。	echo "helloWorld"
Parameters	string	否	指令碼參數清單。	para1=$bizdate
Trigger	object	是	任務觸發方式。
Type	string	否	觸發方式類型。 Scheduler：排程週期觸發 Manual：手動觸發	Scheduler
Recurrence	string	是	觸發時的執行模式，type=Scheduler 時生效。 Pause：暫停 Skip：空跑 Normal：正常執行	Normal
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	否	輸入資訊。注意，此欄位為空時將預設刪除所有 Inputs 設定。
Variables	array<object>	否	變數定義清單。注意，此欄位未填或為空陣列時將預設刪除所有 Inputs.Variables 設定。
	object	否
Name	string	否	變數名稱。	key1
Type	string	是	類型。 Constant：常量 PassThrough：參數節點輸出 System：變數 NodeOutput：指令碼輸出	Constant
Value	string	否	變數值。	value1
Outputs	object	否	輸出資訊。注意，此欄位為空時將預設刪除所有 Outputs 設定。
TaskOutputs	array<object>	否	任務輸出定義清單。注意，此欄位未填或為空陣列時將預設刪除所有 TaskOutputs 設定。
	object	否
Output	string	否	輸出標識符。	pre.odps_sql_demo_0
Variables	array<object>	否	變數定義清單。注意，此欄位未填或為空陣列時將預設刪除所有 Outputs.Variables 設定。
	object	否
Name	string	否	變數名。	key1
Type	string	是	類型。 Constant：常量 PassThrough：參數節點輸出 System：變數 NodeOutput：指令碼輸出	Constant
Value	string	否	變數值。	value1
Dependencies	array<object>	否	相依性資訊。注意，此欄位未填或為空陣列時將預設刪除所有 Dependencies 設定。
	object	否
Type	string	是	相依性類型。 CrossCycleDependsOnChildren：跨週期相依一級子節點 CrossCycleDependsOnSelf：跨週期相依自身 CrossCycleDependsOnOtherNode：跨週期相依其他節點 Normal：同週期相依	Normal
UpstreamOutput	string	否	上游任務的輸出識別碼。（`同週期相依`且設定 input 內容時，返回此欄位）	pre.odps_sql_demo_0
UpstreamTaskId	integer	否	上游任務的 Id。（`跨週期相依其他節點`與`同週期相依`未設定 input 內容時，返回此欄位，其他情況不返回）	1234
Tags	array<object>	否	任務標籤清單。注意，此欄位未填或為空陣列時將預設刪除所有 Tags 設定。
	object	否
Key	string	是	標籤鍵。	key1
Value	string	否	標籤值。	value1
ClientUniqueCode	string	否	任務的用戶端唯一碼，用於實現非同步和冪等。建立時如果不指定，系統將自動產生，該代碼將與資源 ID 進行唯一綁定。更新、刪除資源時如果指定該參數，應與建立時的用戶端唯一碼保持一致。	Task_0bc5213917368545132902xxxxxxxx
EnvType	string	否	專案環境。 Prod：生產 Dev：開發	Prod
Outputs	object	否	輸出資訊。
TaskOutputs	array<object>	否	工作流程任務輸出定義清單。
	object	否
Output	string	否	輸出識別碼。	pre.odps_sql_demo_0
Tags	array<object>	否	工作流程標籤清單。
	object	否
Key	string	是	標籤鍵。	key1
Value	string	否	標籤值。	value1
ClientUniqueCode	string	否	工作流程的用戶端唯一碼，用於實現非同步和冪等。建立時如果不指定，系統將自動產生，該代碼將與資源 ID 進行唯一綁定。更新、刪除資源時如果指定該參數，應與建立時的用戶端唯一碼保持一致。	Workflow_0bc5213917368545132902xxxxxxxx
InstanceMode	string	否	執行個體產生模式。 T+1（第二天產生） Immediately（立即產生）。注意：工作流程排程時間在工作流程發佈時間點十分鐘後的週期執行個體才會正常產生。全量轉執行個體期間（22:00~24:00 點期間）不能進行即時轉執行個體，可以提交發佈工作流程，但提交後不會重新產生執行個體。	T+1

返回參數

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

樣本

正常返回樣本

JSON格式

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

錯誤碼

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

變更歷史

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