全部產品
Search
文件中心

DataWorks:ListInstanceHistory

更新時間:Jul 31, 2026

呼叫 ListInstanceHistory,取得所有執行個體歷史記錄,任務重跑一次就會產生一筆歷史記錄。

調試

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

調試

授權資訊

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

請求參數

名稱

類型

必填

描述

樣本值

InstanceId

integer

是

執行個體的 ID。您可以呼叫 ListInstances 取得。

1234

ProjectEnv

string

否

工作空間的環境,包括 PROD(生產環境)和 DEV(開發環境),預設取得 PROD(生產環境)的執行個體資料。

PROD

返回參數

名稱

類型

描述

樣本值

object

返回結果。

RequestId

string

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

E6F0DBDD-5AD****

Success

boolean

呼叫是否成功。取值如下:

  • true:呼叫成功。

  • false:呼叫失敗。

true

Instances

array<object>

執行個體清單。

object

執行個體詳情。

Status

string

任務的狀態,取值如下:

  • NOT_RUN(未執行)

  • WAIT_TIME(等待排程時間 DueTime 或 CycTime 到來)

  • WAIT_RESOURCE(等待資源)

  • RUNNING(執行中)

  • CHECKING(下發給資料品質進行資料校驗)

  • CHECKING_CONDITION(正在進行分支條件校驗)

  • FAILURE(執行失敗)

  • SUCCESS(執行成功)

NOT_RUN

CycTime

integer

排程任務的執行時間,返回時間戳記格式。

1590422400000

BeginRunningTime

integer

執行個體開始執行的時間,返回時間戳記格式。

1590416703313

FinishTime

integer

排程任務的結束時間,返回時間戳記格式。

1590416703313

ErrorMessage

string

執行個體執行的錯誤訊息。該欄位已廢棄,您可以呼叫 GetInstanceLog 介面取得執行任務的相關錯誤訊息。

error message

CreateTime

integer

執行個體的建立時間。

格式範例為 13 位數字,例如 1590416703313。

1590416703313

DagId

integer

工作流程的 ID。

33845

TaskType

string

任務執行個體的排程類型,取值如下:

  • NORMAL(0):正常排程任務。該任務被日常排程。

  • MANUAL(1):手動任務。該任務不會被日常排程。

  • PAUSE(2):凍結任務。該任務被日常排程,但啟動排程時直接被置為失敗狀態。

  • SKIP(3):空跑任務。該任務被日常排程,但啟動排程時直接被置為成功狀態。

  • SKIP_UNCHOOSE(4):臨時工作流程中未選擇的任務,僅存在於臨時工作流程中,啟動排程時直接被置為成功狀態。

  • SKIP_CYCLE(5):未到執行週期的週或月任務。該任務被日常排程,但啟動排程時直接被置為成功狀態。

  • CONDITION_UNCHOOSE(6):上游執行個體中有分支(IF)節點,但是該下游節點未被分支節點選中,直接置為空跑任務。

  • REALTIME_DEPRECATED(7):即時產生的已經過期的週期執行個體,該類型的任務直接被置為成功狀態。

NORMAL(0)

DagType

string

DQC 類型,取值如下:

  • 0 表示有關聯 dqc。

  • 1 表示沒有關聯 dqc。

1

ModifyTime

integer

排程任務的最新修改時間。

格式範例為 13 位數字,例如 1590416703313。

1590416703313

InstanceId

integer

執行個體的 ID。

1234

BeginWaitResTime

integer

執行個體任務開始等待資源的時間。

格式範例為 13 位數字,例如 1590416703313。

1590416703313

Bizdate

integer

執行排程任務的日期。通常為該任務執行時間的前一天。

格式範例為 13 位數字,例如 1590336000000。

1590336000000

NodeName

string

節點的名稱。

kzh

BeginWaitTimeTime

integer

執行個體任務開始等待排程的時間。

格式範例為 13 位數字,例如 1590416703313。

1590416703313

NodeId

integer

節點的 ID。

33115

InstanceHistoryId

integer

執行個體的歷史檔案編號。

1

樣本

正常返回樣本

JSON格式

{
  "RequestId": "E6F0DBDD-5AD****",
  "Success": true,
  "Instances": [
    {
      "Status": "NOT_RUN",
      "CycTime": 1590422400000,
      "BeginRunningTime": 1590416703313,
      "FinishTime": 1590416703313,
      "ErrorMessage": "error message",
      "CreateTime": 1590416703313,
      "DagId": 33845,
      "TaskType": "NORMAL(0)",
      "DagType": "1",
      "ModifyTime": 1590416703313,
      "InstanceId": 1234,
      "BeginWaitResTime": 1590416703313,
      "Bizdate": 1590336000000,
      "NodeName": "kzh",
      "BeginWaitTimeTime": 1590416703313,
      "NodeId": 33115,
      "InstanceHistoryId": 1
    }
  ]
}

錯誤碼

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

變更歷史

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