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

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

介面說明

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:CreateWorkflowInstances

create

*All Resource

*

無

請求參數

名稱	類型	必填	描述	樣本值
ProjectId	integer	是	專案 ID。	100
EnvType	string	否	專案環境。 Prod：生產 Dev：開發枚舉值： 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：冒煙測試。僅需填 RootTaskIds，即為要執行的測試任務清單。 TriggerWorkflow：觸發式工作流。WorkflowId 需要填觸發式工作流的 WorkflowId，IncludeTaskIds 選填，不填則會執行整個工作流。枚舉值： SmokeTest : 冒煙測試。僅需填 RootTaskIds，即為要執行的測試任務清單。 TriggerWorkflow : 觸發式工作流。WorkflowId 需要填觸發式工作流的 WorkflowId，IncludeTaskIds 選填，不填則會執行整個工作流。 Manual : 手動任務。僅需填 RootTaskIds，即為要執行的手動任務清單。 SupplementData : 補資料。RootTaskIds 與 IncludeTaskIds 的填寫方法隨補資料模式而變化，見 DefaultRunProperties.Mode 參數說明。 ManualWorkflow : 手動業務流程。WorkflowId 需要填手動業務流程的 WorkflowId，RootTaskIds 選填，不填則會使用手動業務流程預設的根節點清單。	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 : 每天。 Weekend : 僅週末。	Daily
Immediately	boolean	否	執行時間在未來是否可以立即執行起來，預設為 false。	false
Alert	object	否	警報配置。
Type	string	否	警示策略。 Success 成功警示 Failure 失敗警示 SuccessFailure 成功和失敗都警示枚舉值： SuccessFailure : 成功和失敗都警報。 Failure : 失敗警報。 Success : 成功警報。	Succes
NoticeType	string	否	通知方式。 Sms：僅簡訊 Mail：僅電子郵件 SmsMail：簡訊加電子郵件。枚舉值： Mail : 僅電子郵件。 Sms : 僅簡訊。 SmsMail : 簡訊加電子郵件。	Sms
Parallelism	integer	否	任務平行數。取值 2~10 時為平行度，取值 1 時為序列。Type=SupplementData 時必填。	2
Order	string	否	執行順序，預設為 Asc。 Asc：按業務日期升序。 Desc：按業務日期降序。枚舉值： Asc : 按業務日期升序。 Desc : 按業務日期降序。	Asc
RuntimeResource	string	否	自訂排程資源群組識別碼，該欄位為空則跟隨任務配置。	S_res_group_524258031846018_1684XXXXXXXXX
Priority	integer	否	執行優先順序，取值範圍為 1~11。取值越大，優先順序越高。（該參數配置只支援手動業務流程與觸發式工作流）。	1
PriorityWeightStrategy	string	否	優先順序權重策略。（該參數配置只支援手動業務流程與觸發式工作流） `Disable`：不啟用（預設） `Upstream`：當前節點計算上游的權重總和。即層次越深，權重越高。枚舉值： Upstream : 按上游權重。 Disable : 停用。	Upstream
Comment	string	否	建立的原因說明。	create for test
Tags	array<object>	否	任務標籤清單。
	object	否
Value	string	否	標籤值。	tagValue
Key	string	否	標籤鍵。	tagKey
TagCreationPolicy	string	否	標籤建立策略。 Append：追加模式，在繼承手動業務流程已有標籤的基礎上追加新的標籤。 Overwrite：覆蓋模式，不繼承手動業務流程已有標籤，直接建立標籤。枚舉值： Overwrite : 覆蓋模式，不繼承手動業務流程已有標籤，直接建立標籤。 Append : 追加模式，在繼承手動業務流程已有標籤的基礎上追加新的標籤。	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"
}

錯誤碼

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

變更歷史

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