全部產品
Search

搜尋本產品

    DataWorks：GetPipelineRun - 擷取發布流程詳細資料

    文件中心

    DataWorks：GetPipelineRun - 擷取發布流程詳細資料

    更新時間：Mar 21, 2026

    調用此介面，擷取發布流程詳細資料。

    介面說明

    重要 低版本的 SDK 中可能無該介面，此時請使用 GetDeployment 介面，參數與該文檔一致。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dataworks:*

    get

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    ProjectId

    integer

    是

    DataWorks 工作空間的 ID。您可以登入 DataWorks 控制台，進入工作空間管理頁面擷取 ID。

    該參數用來確定本次 API 呼叫操作使用的 DataWorks 工作空間。

    10000
    Id

    string

    是

    發布流程的唯一識別碼。

    a7ef0634-20ec-4a7c-a214-54020f****

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Schema of Response

    RequestId

    string

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

    08468352-032C-5262-AEDC-68C9FA05XXXX
    Pipeline

    object

    整個發布流程的資訊

    Id

    string

    發布流程 Id

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

    ProjectId

    integer

    DataWorks 工作空間的 ID。

    56160
    CreateTime

    integer

    發布包建立時間戳記

    1724984066000
    ModifyTime

    integer

    修改時間

    1724984066000
    Creator

    string

    建立人

    137946317766XXXX
    Status

    string

    發布流程狀態

    可選值：

    • Init 初始化

    • Running 運行中

    • Success 運行成功

    • Fail 運行失敗

    • Termination 被終止

    • Cancel 被取消

    Running
    Message

    string

    發布失敗的錯誤資訊

    Error message
    Stages

    array<object>

    步驟詳情

    array<object>

    stage 的元素

    Code

    string

    發布階段代號

    DEV_CHECK
    Step

    integer

    發布階段步驟編號

    1
    Type

    string

    發布階段類型

    可選值

    • Deploy 發佈動作

    • Check 檢查操作

    • Offline 下線操作

    • Build 構建操作

    • Delete 刪除操作

    枚舉值：

    • Delete :

      Delete

    • Build :

      Build

    • Check :

      Check

    • Offline :

      Offline

    • Deploy :

      Deploy

    Check
    Name

    string

    階段名稱

    Publish package build
    Description

    string

    階段描述

    Phase description
    Message

    string

    發布階段異常資訊

    Exception information XXX
    Status

    string

    發布階段狀態

    可選值：

    • Init 初始化

    • Running 運行中

    • Success 運行成功

    • Fail 運行失敗

    • Termination 被終止

    • Cancel 被取消

    枚舉值：

    • Init :

      Init

    • Cancel :

      Cancel

    • Running :

      Running

    • Termination :

      Termination

    • Success :

      Success

    • Fail :

      Fail

    Running
    Detail

    object

    階段詳細資料

    any

    階段額外的資訊描述

    "checkerList": [ { "code": "BuildPackageChecker", "name": "Build_Package_Checker" }, { "code": "NodeParentDependency", "name": "Downstream_Dependency_Checker" }, { "code": "NodeInProcess", "name": "Decommissioning_Process_Checker" } ]

    Description

    string

    發布流程描述資訊

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "08468352-032C-5262-AEDC-68C9FA05XXXX",
  "Pipeline": {
    "Id": "a7ef0634-20ec-4a7c-a214-54020f91XXXX\n",
    "ProjectId": 56160,
    "CreateTime": 1724984066000,
    "ModifyTime": 1724984066000,
    "Creator": "137946317766XXXX",
    "Status": "Running",
    "Message": "Error message",
    "Stages": [
      {
        "Code": "DEV_CHECK",
        "Step": 1,
        "Type": "Check",
        "Name": "Publish package build",
        "Description": "Phase description",
        "Message": "Exception information XXX",
        "Status": "Running",
        "Detail": {
          "key": "\"checkerList\": [\n    {\n        \"code\": \"BuildPackageChecker\",\n        \"name\": \"Build_Package_Checker\"\n    },\n    {\n        \"code\": \"NodeParentDependency\",\n        \"name\": \"Downstream_Dependency_Checker\"\n    },\n    {\n        \"code\": \"NodeInProcess\",\n        \"name\": \"Decommissioning_Process_Checker\"\n    }\n]\n"
        }
      }
    ],
    "Description": "發布流程描述資訊"
  }
}

    錯誤碼

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

    變更歷史

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