全部產品
Search

搜尋本產品

    DataWorks：CreatePipelineRun

    文件中心

    DataWorks：CreatePipelineRun

    更新時間：Jul 06, 2026

    呼叫此介面，可以對新版資料開發中的實體建立一個發佈流程。

    介面說明

    重要 該介面目前不支援批次操作，參數中填寫多個發佈實體時，除第一個以外的部分會被直接忽略。
    重要 低版本的 SDK 中可能無該介面，此時請使用 CreateDeployment 介面，參數與該文件一致。

    調試

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

    調試

    授權資訊

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

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

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dataworks:*

    create

    *全部資源。

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    ProjectId

    integer

    是

    DataWorks 工作空間的 ID。您可以登入 DataWorks 主控台，進入工作空間設定頁面取得工作空間 ID。 該參數用來確定本次 API 呼叫操作使用的 DataWorks 工作空間。

    10000
    Type

    string

    是

    表示發佈流程是上線還是下線。

    • Online：上線

    • Offline：下線

    Online
    ObjectIds

    array

    是

    本次發佈流程希望發佈的實體 ID 清單。

    重要 目前只支援對於單個實體及其子實體的發佈，因此只有該 array 的第一個實體及其子實體會被發佈成功。請確保該 array 的長度為 1，超出 1 的部分會被忽略。

    string

    否

    希望發佈的實體 ID，如 Node、WorkflowDefinition 等實體的 ID。

    重要 WorkflowDefinition 只允許作為整體發佈，目前不支援單獨發佈 Workflow 內部的單個節點。

    476506242076571XXXX
    Description

    string

    否

    對於發佈流程的描述資訊。

    This is a OdpsSQL-node publishing process. The function is XXXX.
    RunMode

    string

    否

    發佈流程的執行模式，預設為 Normal。當填寫 Auto 時，會自動驅動該發佈流程跑到指定階段，需要配合 AutoRunUntilStage 欄位使用。

    可選值：

    • Normal

    • Auto

    Normal
    AutoRunUntilStage

    string

    否

    需要填寫發佈流程 Stage 對應的 Code。當 RunMode 為 Auto 時生效，該發佈流程會在建立後自動執行到指定階段。

    重要 指定階段會被自動執行完。例如填寫 DEV 時，自動執行會在 DEV 階段到達終態後停止。

    DEV

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Schema of Response

    RequestId

    string

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

    7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX
    Id

    string

    發佈流程的唯一識別碼。

    a7ef0634-20ec-4a7c-a214-54020f91XXXX

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX",
  "Id": "a7ef0634-20ec-4a7c-a214-54020f91XXXX\n"
}

    錯誤碼

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

    變更歷史

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