全部產品
Search
文件中心

DataWorks:ListDeployments - 查詢發布包列表資訊

更新時間:Mar 21, 2026

查詢發布包列表資訊。該功能與DataWorks控制台任務發佈頁面的發布包列表功能對應。

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

ProjectIdentifier

string

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

該參數與 ProjectId 參數,二者必須設定其一,用來確定本次 API 呼叫操作的 DataWorks 工作空間。

dw_project

ProjectId

integer

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

該參數與 ProjectIdentifier 參數,二者必須設定其一,用來確定本次 API 呼叫操作的 DataWorks 工作空間。

10000

Creator

string

發布包建立者的阿里雲使用者識別碼。

20030****

EndCreateTime

integer

產生發布包的最大毫秒時間戳記。

1593877765000

Executor

string

發布包執行者的阿里雲使用者識別碼。

2003****

EndExecuteTime

integer

發布包開始執行的最大毫秒時間戳記。

1593877765000

Status

integer

發布包當前的狀態。取值如下:

  • 0:發布包已準備就緒。

  • 1:發布包發布成功。

  • 2:發布包發布失敗。

  • 6:發布包被駁回。

1

Keyword

string

發布包名稱的關鍵字。DataWorks 支援模糊比對,即輸入關鍵字,即可查詢包含該關鍵字的發布包。

hello

PageNumber

integer

請求的資料頁數,用於翻頁。

1

PageSize

integer

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

20

返回參數

名稱

類型

描述

樣本值

object

返回結果。

RequestId

string

請求 ID。用於出現錯誤後排查問題。

0000-ABCD-EFG

Data

object

滿足查詢條件的發布包列表資料。

PageNumber

integer

請求的資料頁數,用於翻頁。

1

PageSize

integer

每頁顯示的資料條數。

10

TotalCount

integer

滿足條件的資料總條數。

13

Deployments

array<object>

返回的發布包列表。

object

發布包的詳細資料。

Status

integer

發布包當前的狀態。取值如下:

  • 0:發布包已準備就緒。

  • 1:發布包發布成功。

  • 2:發布包發布失敗。

  • 6:發布包被駁回。

1

ErrorMessage

string

當發布包執行失敗,該參數用於記錄錯誤資訊。

OK

CreateTime

integer

發布包建立的時間戳記。

1593877765000

Executor

string

發布包執行者的阿里雲使用者識別碼。

2003****

Creator

string

發布包建立者的阿里雲使用者識別碼。

2003****

ExecuteTime

integer

執行發布包的時間戳記。

1593877765000

Name

string

發布包的名稱。

auto_created

Id

integer

發布包的 ID,您可以根據此 ID 調用 GetDeployment 介面,擷取發布包詳情。

11111

樣本

正常返回樣本

JSON格式

{
  "RequestId": "0000-ABCD-EFG",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 13,
    "Deployments": [
      {
        "Status": 1,
        "ErrorMessage": "OK",
        "CreateTime": 1593877765000,
        "Executor": "2003****",
        "Creator": "2003****",
        "ExecuteTime": 1593877765000,
        "Name": "auto_created",
        "Id": 11111
      }
    ]
  }
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

500 InternalError.System An internal system error occurred. Try again later.
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. 沒有許可權,請授權
429 Throttling.Api The request for this resource has exceeded your available limit.
429 Throttling.System The DataWorks system is busy. Try again later.
429 Throttling.User Your request is too frequent. Try again later.

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

變更歷史

更多資訊,參考變更詳情