全部產品
Search
文件中心

DataWorks:CreateWorkflowDefinition - 建立資料開發工作流程

更新時間:Mar 21, 2026

調用該介面,在資料開發指定目錄下建立一個工作流程。

介面說明

重要 該介面不支援大量操作,若 FlowSpec 中定義了不止一個工作流程,則除第一個以外的後續工作流程均會被忽略。此外,工作流程內部定義的節點也會被直接忽略,請調用 CreateNode 介面依次建立內部節點。

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:*

create

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

ProjectId

integer

DataWorks 工作空間的 ID。您可以登入 DataWorks 控制台,進入工作空間配置頁面擷取工作空間 ID。

10000

Spec

string

描述這個工作流程的 FlowSpec 資訊,具體規範詳見 FlowSpec

說明

如何快速擷取 FlowSpec 模板?

  • 在資料開發中開啟工作流程->點擊右上方“顯示 Spec,即可得到針對當前工作流程的 FlowSpec 描述。可以基於該 FlowSpec 描述快速構建符合要求的模板。

重要 該介面只支援建立 Workflow,FlowSpec 描述的內部節點不會被建立出來。

{ "kind": "CycleWorkflow", "version": "1.1.0", "spec": { "name": "OpenAPITestWorkflowDemo", "type": "CycleWorkflow", "workflows": [ { "script": { "path": "XX/OpenAPITest/WorkflowTest/OpenAPITestWorkflowDemo", "runtime": { "command": "WORKFLOW" } }, "trigger": { "type": "Scheduler", "cron": "00 02 00 * * ?", "startTime": "1970-01-01 00:00:00", "endTime": "9999-01-01 00:00:00", "timezone": "Asia/Shanghai", "delaySeconds": 0 }, "strategy": { "timeout": 0, "instanceMode": "T+1", "rerunMode": "Allowed", "rerunTimes": 3, "rerunInterval": 180000, "failureStrategy": "Break" }, "name": "OpenAPITestWorkflowDemo", "outputs": { "nodeOutputs": [ { "data": "workflow_output", "artifactType": "NodeOutput", "refTableName": "OpenAPITestWorkflowDemo" } ] }, "dependencies": [] } ] } }

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

RequestId

string

請求 ID。用於定位日誌,排查問題。

0EF298E5-0940-5AC7-9CB0-6502507****

Id

string

資料開發工作流程的唯一識別碼。

重要 該欄位在 SDK8.0.0 版本之前為 Long 類型,SDK8.0.0 版本及之後為 String 類型。該變更不影響 SDK 正常使用,參數仍會按 SDK 中定義的類型返回。只有在跨 8.0.0 版本的 SDK 升級時,類型變更可能會導致專案編譯不通過,需要使用者手動修正資料類型。

463497880880954XXXX

樣本

正常返回樣本

JSON格式

{
  "RequestId": "0EF298E5-0940-5AC7-9CB0-6502507****",
  "Id": "463497880880954XXXX"
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情