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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ListInstanceHistory

系统规定参数。取值：ListInstanceHistory。

InstanceId Long 是 1234

实例的ID。您可以调用ListInstances获取。
RegionId String 是 cn-shanghai

地域信息，通常是服务所在的地域。例如，华东2（上海）是cn-shanghai，华北3（张家口）是cn-zhangjiakou。您无需填写RegionId，会根据调用的endpoint自动解析。
ProjectEnv String 否 PROD

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

返回数据

名称 类型 示例值 描述
RequestId String E6F0DBDD-5AD****

请求的ID。用于定位日志，排查问题。
Success Boolean true

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

  • true：调用成功。
  • false：调用失败。
Instances Array of Instances

实例列表
Status String NOT_RUN

任务的状态，取值如下：

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

调度任务的运行时间，返回时间戳格式。
BeginRunningTime Long 1590416703313

实例开始运行的时间，返回时间戳格式。
FinishTime Long 1590416703313

调度任务的结束时间，返回时间戳格式。
ErrorMessage String error message

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

实例的创建时间。
DagId Long 33845

工作流的ID。
TaskType String NORMAL(0)

任务实例的调度类型，取值如下：

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

DQC类型，取值如下：

  • 0表示有关联dqc。
  • 1表示没有关联dqc。
ModifyTime Long 1590416703313

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

实例的ID。
BeginWaitResTime Long 1590416703313

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

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

节点的名称。
BeginWaitTimeTime Long 1590416703313

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

节点的ID。
InstanceHistoryId Long 1

实例的历史档案编号。

示例

请求示例

http(s)://[Endpoint]/?Action=ListInstanceHistory
&InstanceId=1234
&ProjectEnv=PROD
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<ListInstanceHistoryResponse>
    <RequestId>E6F0DBDD-5AD****</RequestId>
    <Success>true</Success>
    <Instances>
        <Status>NOT_RUN</Status>
        <CycTime>1590422400000</CycTime>
        <BeginRunningTime>1590416703313</BeginRunningTime>
        <FinishTime>1590416703313</FinishTime>
        <ErrorMessage>error message</ErrorMessage>
        <CreateTime>1590416703313</CreateTime>
        <DagId>33845</DagId>
        <TaskType>NORMAL(0)</TaskType>
        <DagType>1</DagType>
        <ModifyTime>1590416703313</ModifyTime>
        <InstanceId>1234</InstanceId>
        <BeginWaitResTime>1590416703313</BeginWaitResTime>
        <Bizdate>1590336000000</Bizdate>
        <NodeName>kzh</NodeName>
        <BeginWaitTimeTime>1590416703313</BeginWaitTimeTime>
        <NodeId>33115</NodeId>
        <InstanceHistoryId>1</InstanceHistoryId>
    </Instances>
</ListInstanceHistoryResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/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
  } ]
}

错误码

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