全部產品
Search
文件中心

DataWorks:ListPipelineRuns - 擷取發布流程列表

更新時間:Apr 23, 2026

分頁擷取發布流程列表,也可以使用篩選條件對發布流程進行篩選。

介面說明

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

調試

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

調試

授權資訊

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

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

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

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:*

list

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

ProjectId

integer

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

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

10000

Creator

string

篩選條件:發布流程的建立者

110755000425****

Status

string

篩選條件:發布流程的目前狀態

可選值:

  • Init 初始化

  • Running 運行中

  • Success 運行成功

  • Fail 運行失敗

  • Termination 被終止

  • Cancel 被取消

Running

ObjectId

string

發布物的 ID

860438872620113XXXX

PageNumber

integer

頁碼,從 1 開始,預設值為 1。

1

PageSize

integer

每頁顯示的條數,預設為 10 條,最大 100 條。

10

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

RequestId

string

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

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

PagingInfo

object

分頁資訊。

TotalCount

integer

滿足條件的資料總條數。

2524

PageSize

integer

每頁顯示的條數

10

PageNumber

integer

查詢分頁的頁碼。

1

PipelineRuns

array<object>

發布流程資訊列表。

array<object>

發布流程列表元素

Id

string

發布流程 Id

097c73fe-ed6e-4fb1-b109-a5d59e46cd58

ProjectId

integer

專案 Id

70199

CreateTime

integer

發布包建立時間戳記

1702736654000

ModifyTime

integer

修改時間

1702736654000

Creator

string

建立人

110755000425XXXX

Status

string

發布流程狀態

可選值

  • Init 初始化

  • Running 運行中

  • Success 運行成功

  • Fail 運行失敗

  • Termination 被終止

  • Cancel 被取消

Running

Message

string

發布階段發生錯誤時的錯誤資訊

Error message

Stages

array<object>

發布階段列表

array<object>

發布階段列表元素

Code

string

發布階段代號

DEV_CHECK

Step

integer

發布階段步驟編號

1

Type

string

發布階段類型,是該發布階段操作類型的一個分類。

可選值

  • Deploy 發佈動作

  • Check 檢查操作

  • Offline 下線操作

  • Build 構建操作

  • Delete 刪除操作

Check

Name

string

階段名稱

Check before going online to development

Description

string

階段描述

Check before going online to development

Message

string

發布階段發生錯誤時的錯誤資訊

Error message

Status

string

發布階段狀態

可選值

  • Init 初始化

  • Running 運行中

  • Success 運行成功

  • Fail 運行失敗

  • Termination 被終止

  • Cancel 被取消

Running

Detail

object

發布階段的其他補充資訊

any

補充資訊

{ "checkerList": [ { "code": "BuildPackageChecker", "name": "package check" }, { "code": "NodeParentDependency", "name": "downstream dependency check" }, { "code": "NodeInProcess", "name": "offline process check" } ] }

Description

string

發布流程的描述資訊

發布流程描述資訊

樣本

正常返回樣本

JSON格式

{
  "RequestId": "7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX\n",
  "PagingInfo": {
    "TotalCount": 2524,
    "PageSize": 10,
    "PageNumber": 1,
    "PipelineRuns": [
      {
        "Id": "097c73fe-ed6e-4fb1-b109-a5d59e46cd58",
        "ProjectId": 70199,
        "CreateTime": 1702736654000,
        "ModifyTime": 1702736654000,
        "Creator": "110755000425XXXX",
        "Status": "Running",
        "Message": "Error message",
        "Stages": [
          {
            "Code": "DEV_CHECK",
            "Step": 1,
            "Type": "Check",
            "Name": "Check before going online to development\n",
            "Description": "Check before going online to development\n",
            "Message": "Error message\n",
            "Status": "Running",
            "Detail": {
              "key": "{\n  \"checkerList\": [\n    {\n      \"code\": \"BuildPackageChecker\",\n      \"name\": \"package check\"\n    },\n    {\n      \"code\": \"NodeParentDependency\",\n      \"name\": \"downstream dependency check\"\n    },\n    {\n      \"code\": \"NodeInProcess\",\n      \"name\": \"offline process check\"\n    }\n  ]\n}"
            }
          }
        ],
        "Description": "發布流程描述資訊"
      }
    ]
  }
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情