全部產品
Search

搜尋本產品

    Data Management：ListTaskFlowInstance - 擷取任務流程執行記錄

    文件中心

    Data Management：ListTaskFlowInstance - 擷取任務流程執行記錄

    更新時間：Mar 21, 2026

    調用ListTaskFlowInstance介面，擷取任務流程執行記錄。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dms:ListTaskFlowInstance

    list

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DagId

    integer

    是

    任務流 ID，可通過調用介面 ListTaskFlow 或 ListLhTaskFlowAndScenario 擷取該參數的值。

    7***
    TriggerType

    integer

    否

    觸發類型，取值如下：

    • 0：周期調度

    • 1：手動運行

    1
    StartTimeBegin

    string

    否

    篩選出指定時間之後開始的任務流程執行記錄。時間格式為 yyyy-MM-DD。

    2022-01-07
    StartTimeEnd

    string

    否

    篩選出指定時間之前開始的任務流程執行記錄。時間格式為 yyyy-MM-DD。

    2022-04-08
    PageIndex

    integer

    是

    第幾頁。

    1
    PageSize

    integer

    是

    每頁資料量。

    20
    Tid

    integer

    否

    租戶 ID。您可以調用 GetUserActiveTenant 或 ListUserTenants 介面擷取該參數。

    3***
    UseBizDate

    boolean

    否

    調整篩選條件：
    true: StartTimeBegin 和 StartTimeEnd 為篩選業務時間區間範圍。
    false: StartTimeBegin 和 StartTimeEnd 為任務已耗用時間區間範圍。

    true
    Status

    integer

    否

    任務節點運行狀態，取值如下：

    • 1：正在運行

    • 2：運行成功

    • 3：運行失敗

    • 4：等待調度

    2

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    8CFF2295-8249-5287-B888-DBD4F0D76CB0
    ErrorCode

    string

    錯誤碼。

    UnknownError
    ErrorMessage

    string

    錯誤資訊。

    UnknownError
    Success

    boolean

    請求是否成功，傳回值如下：

    • true：請求成功

    • false：請求失敗

    true
    DAGInstanceList

    object

    DAGInstance

    array<object>

    任務流程執行記錄列表。

    object

    任務流程執行記錄列表。

    Id

    integer

    運行記錄 ID。

    9234
    BusinessTime

    string

    任務流業務時間，時間格式為 yyyy-MM-DD HH:mm:ss。

    2021-11-10 14:37:26
    startTime

    string

    任務流程執行開始時間，時間格式為 yyyy-MM-DD HH:mm:ss。

    2021-11-11 14:35:57

    EndTime

    string

    任務流程執行結束時間，時間格式為 yyyy-MM-DD HH:mm:ss。

    2021-11-11 14:38:57
    DagId

    string

    任務流 ID。

    7***
    TriggerType

    integer

    觸發類型。傳回值如下：

    • 0：周期調度

    • 1：手動運行

    1
    Status

    integer

    任務流狀態，傳回值如下：

    • 0：等待調度

    • 1：運行中

    • 2：暫停

    • 3：失敗

    • 4：成功

    • 5：完成

    4
    Message

    string

    任務描述資訊。

    test
    HistoryDagId

    integer

    歷史任務流版本 ID。

    2****
    DagName

    string

    任務流名稱。

    Spark_SQL_test
    OwnerName

    string

    任務流 Owner 的名稱。

    test_name
    DagVersion

    string

    任務流版本。

    []
    TotalCount

    integer

    滿足條件運行記錄總個數。

    1

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "8CFF2295-8249-5287-B888-DBD4F0D76CB0",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "DAGInstanceList": {
    "DAGInstance": [
      {
        "Id": 9234,
        "BusinessTime": "2021-11-10 14:37:26",
        "startTime": "2021-11-11 14:35:57\n",
        "EndTime": "2021-11-11 14:38:57",
        "DagId": "7***",
        "TriggerType": 1,
        "Status": 4,
        "Message": "test",
        "HistoryDagId": 0,
        "DagName": "Spark_SQL_test",
        "OwnerName": "test_name",
        "DagVersion": "[]"
      }
    ]
  },
  "TotalCount": 1
}

    錯誤碼

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

    變更歷史

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