ListInstanceHistory - 获取所有实例历史记录

调用ListInstanceHistory,获取所有实例历史记录,任务重跑一次就会生成一条历史记录。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdlong

实例的 ID。您可以调用 ListInstances 获取。

1234
ProjectEnvstring

工作空间的环境,包括 PROD(生产环境)和 DEV(开发环境),默认获取 PROD(生产环境)的实例数据。

PROD

返回参数

名称类型描述示例值
object

返回结果

RequestIdstring

请求的 ID。用于定位日志,排查问题。

E6F0DBDD-5AD****
Successboolean

调用是否成功。取值如下:

  • true:调用成功。
  • false:调用失败。
true
Instancesarray<object>

实例列表

Instancesobject

实例详情

Statusstring

任务的状态,取值如下:

  • NOT_RUN(未运行)
  • WAIT_TIME(等待定时时间 DueTime 或 CycTime 到来)
  • WAIT_RESOURCE(等待资源)
  • RUNNING(运行中)
  • CHECKING(下发给数据质量进行数据校检)
  • CHECKING_CONDITION(正在进行分支条件校检)
  • FAILURE(执行失败)
  • SUCCESS(执行成功)
NOT_RUN
CycTimelong

调度任务的运行时间,返回时间戳格式。

1590422400000
BeginRunningTimelong

实例开始运行的时间,返回时间戳格式。

1590416703313
FinishTimelong

调度任务的结束时间,返回时间戳格式。

1590416703313
ErrorMessagestring

实例运行的报错信息。该字段已废弃,您可以调用 GetInstanceLog 接口获取执行任务的相关报错信息。

error message
CreateTimelong

实例的创建时间。

1590416703313
DagIdlong

工作流的 ID。

33845
TaskTypestring

任务实例的调度类型,取值如下:

  • NORMAL(0):正常调度任务。该任务被日常调度。
  • MANUAL(1):手动任务。该任务不会被日常调度。
  • PAUSE(2):冻结任务。该任务被日常调度,但启动调度时直接被置为失败状态。
  • SKIP(3):空跑任务。该任务被日常调度,但启动调度时直接被置为成功状态。
  • SKIP_UNCHOOSE(4):临时工作流中未选择的任务,仅存在于临时工作流中,启动调度时直接被置为成功状态。
  • SKIP_CYCLE(5):未到运行周期的周或月任务。该任务被日常调度,但启动调度时直接被置为成功状态。
  • CONDITION_UNCHOOSE(6):上游实例中有分支(IF)节点,但是该下游节点未被分支节点选中,直接置为空跑任务。
  • REALTIME_DEPRECATED(7):实时生成的已经过期的周期实例,该类型的任务直接被置为成功状态。
NORMAL(0)
DagTypestring

DQC 类型,取值如下:

  • 0 表示有关联 dqc。
  • 1 表示没有关联 dqc。
1
ModifyTimelong

调度任务的最新修改时间。

1590416703313
InstanceIdlong

实例的 ID。

1234
BeginWaitResTimelong

实例任务开始等待资源的时间。

1590416703313
Bizdatelong

执行调度任务的日期。通常为该任务运行时间的前一天。

1590336000000
NodeNamestring

节点的名称。

kzh
BeginWaitTimeTimelong

实例任务开始等待调度的时间。

1590416703313
NodeIdlong

节点的 ID。

33115
InstanceHistoryIdlong

实例的历史档案编号。

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
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史