全部產品
Search

搜尋本產品

    DataWorks：ListWorkflowDefinitions - 擷取資料開發工作流程列表

    文件中心

    DataWorks：ListWorkflowDefinitions - 擷取資料開發工作流程列表

    更新時間：Mar 21, 2026

    分頁擷取資料開發工作流程列表，也可以根據篩選條件對工作流程進行篩選。

    調試

    您可以在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
    Type

    string

    否

    篩選條件：工作流程的類型，未填寫則預設為 CycleWorkflow

    可選值

    • CycleWorkflow

    • ManualWorkflow

    CycleWorkflow
    Owner

    string

    否

    負責人的 ID，即工作空間管理員的帳號 UID。您可登入阿里雲控制台後，在帳號管理的安全管理中查看帳號 UID。

    110755000425XXXX
    Name

    string

    否

    工作流程的名稱，支援模糊搜尋。

    test
    PageNumber

    integer

    否

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

    1
    PageSize

    integer

    否

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

    10

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Schema of Response

    RequestId

    string

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

    8C3ED0C5-ABAB-55E1-854B-DAC02B11XXXX
    PagingInfo

    object

    分頁資訊

    TotalCount

    integer

    滿足條件的資料總條數。

    227
    PageSize

    integer

    每頁顯示的條數

    10
    PageNumber

    integer

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

    1
    WorkflowDefinitions

    array<object>

    查詢到的工作流程列表

    array<object>

    ProjectId

    integer

    工作流程所在 DataWorks 空間的 ID。

    4710
    Owner

    string

    責任人

    110755000425XXXX
    CreateTime

    integer

    建立工作流程時間戳記

    1698057323000
    ModifyTime

    integer

    最近修改工作流程的時間戳記

    1698057323000
    Description

    string

    描述

    Workflow description
    Type

    string

    工作流程類型

    可選值

    • CycleWorkflow

    • ManualWorkflow

    CycleWorkflow
    Script

    object

    指令碼資訊

    Path

    string

    指令碼路徑

    XX/OpenAPI_test/workflow_test/OpenAPI_test_workflow_Demo
    Runtime

    object

    運行時

    Command

    string

    命令

    WORKFLOW
    Id

    string

    指令碼 id。

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

    698002781368644XXXX
    Name

    string

    工作流程名稱

    OpenAPI test workflow Demo
    Id

    string

    工作流程唯一標識。

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

    463497880880954XXXX

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "8C3ED0C5-ABAB-55E1-854B-DAC02B11XXXX",
  "PagingInfo": {
    "TotalCount": 227,
    "PageSize": 10,
    "PageNumber": 1,
    "WorkflowDefinitions": [
      {
        "ProjectId": 4710,
        "Owner": "110755000425XXXX",
        "CreateTime": 1698057323000,
        "ModifyTime": 1698057323000,
        "Description": "Workflow description",
        "Type": "CycleWorkflow",
        "Script": {
          "Path": "XX/OpenAPI_test/workflow_test/OpenAPI_test_workflow_Demo",
          "Runtime": {
            "Command": "WORKFLOW"
          },
          "Id": "698002781368644XXXX"
        },
        "Name": "OpenAPI test workflow Demo",
        "Id": "463497880880954XXXX"
      }
    ]
  }
}

    錯誤碼

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

    變更歷史

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