調用CreateWorkflowInstances介面建立工作流程執行個體-巨量資料開發治理平台 DataWorks-阿里雲

根據配置建立工作流程執行個體，如補資料工作流程執行個體。

介面說明

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

調試

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

調試

授權資訊

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

請求參數

名稱	類型	必填	描述	樣本值
ProjectId	integer	是	專案 ID。	100
EnvType	string	否	專案環境。 Prod：生產 Dev：開發	Prod
WorkflowId	integer	是	所屬工作流程的 ID。周期任務的 WorkflowId 均為 1。	1
Name	string	是	名稱。	WorkflowInstance1
Periods	object	否	補資料周期設定。
BizDates	array<object>	是	業務日期列表。可指定多段業務日期（最多 7 段）。
	object	否
StartBizDate	string	是	起始業務日期。格式為`yyyy-mm-dd`。	2024-11-20
EndBizDate	string	是	結束業務日期。格式為`yyyy-mm-dd`。	2024-11-24
StartTime	string	否	指定開始周期時間，格式為`hh:mm:ss`，24 小時制，預設 00:00:00。如果填寫此欄位需要 StartTime 與 EndTime 需要同時填寫。	00:00:00
EndTime	string	否	指定結束周期時間，格式為`hh:mm:ss`，24 小時制，預設 23:59:59。如果填寫此欄位需要 StartTime 與 EndTime 需要同時填寫。	23:59:59
Type	string	是	工作流程執行個體的類型。 SupplementData：補資料。RootTaskIds 與 IncludeTaskIds 的填寫方法隨補資料模式而變化，見 DefaultRunProperties.Mode 參數說明 ManualWorkflow：手動商務程序。WorkflowId 需要填手動商務程序的 WorkflowId，RootTaskIds 選填，不填則會使用手動商務程序預設的根節點列表。 Manual：手動任務。僅需填 RootTaskIds，即為要啟動並執行手動工作清單。 SmokeTest：煙霧測試 (Smoke Test)。僅需填 RootTaskIds，即為要啟動並執行測試工作列表。 TriggerWorkflow：觸發式工作流程。WorkflowId 需要填觸發式工作流程的 WorkflowId，IncludeTaskIds 選填，不填則會運行整個工作流程。	SupplementData
WorkflowParameters	string	否	工作流程參數，當指定唯一工作流程（`WorkflowId != 1`）時生效。若為周期工作流程、觸發式工作流程，格式為 key=value，優先順序低於任務參數；若為手動商務程序，格式為 JSON，優先順序高於任務參數。	"key=value" format: key1=value1 key2=value2 JSON format: {"key1":"value1", "key2": "value2"}
TaskParameters	string	否	任務參數，為特定任務設定參數。JSON 格式，key 為任務 ID，value 的格式參考任務指令碼參數（GetTask 介面的結果 Task.Script.Parameter）。	{ "1001": "key1=val2 key2=val2", "1002": "key1=val2 key2=val2" }
AutoStartEnabled	boolean	否	建立後是否直接運行，預設為 true。	true
DefaultRunProperties	object	否	運行時配置。
RootTaskIds	array	否	根任務 ID 列表。 Type=SupplementData 時。除 Mode=Chain 的情況外，RootTaskIds 均必填。 Type=ManualWorkflow 時。RootTaskIds 選填，不填則會使用手動商務程序預設的根節點列表。 Type=Manual 時。RootTaskIds 必填，即為要啟動並執行手動工作清單。 Type=SmokeTest 時：RootTaskIds 必填，即為要啟動並執行測試工作列表。
	integer	否	任務 ID。	1234
IncludeTaskIds	array	否	需要啟動並執行任務 ID 列表。
	integer	否	任務 ID。	1234
ExcludeTaskIds	array	否	不要啟動並執行任務 ID 列表。
	integer	否	任務 ID。	4321
IncludeProjectIds	array	否	需要啟動並執行專案 ID 列表。
	integer	否	專案 ID。	100
ExcludeProjectIds	array	否	不需要啟動並執行專案 ID 列表。
	integer	否	專案 ID。	200
Mode	string	否	補資料模式，預設為 ManualSelection。Type=SupplementData 時必填。 General：普通模式，`RootTaskIds`僅能填一個，`IncludeTaskIds`選填，不填會預設包含`RootTaskIds`中的內容 ManualSelection：手動選擇，`RootTaskIds`能填多個，`IncludeTaskIds`選填，不填會預設包含`RootTaskIds`中的內容 Chain：鏈路，`RootTaskIds`為空白，`IncludeTaskIds`填兩個 id，分別是起始和結束任務 AllDownstream：所有下遊，`RootTaskIds`僅能填一個	ManualSelection
Analysis	object	否	分析配置。Type=SupplementData 時必填。
Enabled	boolean	否	是否開啟分析。Type=SupplementData 時必填。	true
Blocked	boolean	否	分析不通過的情況下是否阻塞運行。Type=SupplementData 時必填。	true
RunPolicy	object	否	運行策略。該欄位為空白則跟隨任務配置。
StartTime	string	否	開始已耗用時間，格式為`hh:mm:ss`，24 小時制。若設定運行策略，此欄位必填。	00:00:00
EndTime	string	否	結束已耗用時間，格式為`hh:mm:ss`，24 小時制。若設定運行策略，此欄位必填。	23:59:59
Type	string	否	時段類型。若設定運行策略，此欄位必填。 Daily：每天 Weekend：僅周末	Daily
Immediately	boolean	否	已耗用時間在未來是否可以立即運行起來，預設為 false。	false
Alert	object	否	警示配置。
Type	string	否	警示策略。 Success 成功警示 Failure 失敗警示 SuccessFailure 成功和失敗都警示	Succes
NoticeType	string	否	通知方式。 Sms：僅簡訊 Mail：僅郵件 SmsMail：簡訊加郵件。	Sms
Parallelism	integer	否	任務並行數。取值 2~10 時為並行度，取值 1 時為串列。Type=SupplementData 時必填。	2
Order	string	否	運行順序，預設為 Asc。 Asc：按業務日期升序。 Desc：按業務日期降序。	Asc
RuntimeResource	string	否	自訂調度資源群組標識符，該欄位為空白則跟隨任務配置。	S_res_group_524258031846018_1684XXXXXXXXX
Priority	integer	否	運行優先順序，取值範圍為 1~11。取值越大，優先順序越高。（該參數配置只支援手動商務程序與觸發式工作流程）	1
PriorityWeightStrategy	string	否	優先順序權重策略。（該參數配置只支援手動商務程序與觸發式工作流程） `Disable`：不啟用（預設） `Upstream`：當前節點計算上遊的權重總和。即層次越深，權重越高。	Upstream
Comment	string	否	建立的原因說明。	create for test
Tags	array<object>	否	任務標籤列表。
	object	否
Value	string	否	標籤值。	tagValue
Key	string	否	標籤鍵。	tagKey
TagCreationPolicy	string	否	標籤建立策略。 Append：追加模式，在繼承手動商務程序已有標籤的基礎上追加新的標籤。 Overwrite：覆蓋模式，不繼承手動商務程序已有標籤，直接建立標籤。	Append

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求的 ID，用於定位日誌，排查問題。	22C97E95-F023-56B5-8852-B1A77A17XXXX
OperationId	string	操作 ID。您可以憑藉此欄位通過 GetCreateWorkflowInstancesResult 介面來查詢建立操作的結果。	e15ad21c-b0e9-4792-8f55-b037xxxxxxxx

樣本

正常返回樣本

JSON格式

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "OperationId": "e15ad21c-b0e9-4792-8f55-b037xxxxxxxx"
}

錯誤碼

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

變更歷史

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