ListInstanceHistory - 获取所有实例历史记录_大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

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

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dataworks:*	Read	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	long	是	实例的 ID。您可以调用 ListInstances 获取。	1234
ProjectEnv	string	否	工作空间的环境，包括 PROD（生产环境）和 DEV（开发环境），默认获取 PROD（生产环境）的实例数据。	PROD

返回参数

名称	类型	描述	示例值
	object	返回结果
RequestId	string	请求的 ID。用于定位日志，排查问题。	E6F0DBDD-5AD****
Success	boolean	调用是否成功。取值如下： true：调用成功。 false：调用失败。	true
Instances	object []	实例列表
Status	string	任务的状态，取值如下： NOT_RUN（未运行） WAIT_TIME（等待定时时间 DueTime 或 CycTime 到来） WAIT_RESOURCE（等待资源） RUNNING（运行中） CHECKING（下发给数据质量进行数据校检） CHECKING_CONDITION（正在进行分支条件校检） FAILURE（执行失败） SUCCESS（执行成功）	NOT_RUN
CycTime	long	调度任务的运行时间，返回时间戳格式。	1590422400000
BeginRunningTime	long	实例开始运行的时间，返回时间戳格式。	1590416703313
FinishTime	long	调度任务的结束时间，返回时间戳格式。	1590416703313
ErrorMessage	string	实例运行的报错信息。该字段已废弃，您可以调用 GetInstanceLog 接口获取执行任务的相关报错信息。	error message
CreateTime	long	实例的创建时间。	1590416703313
DagId	long	工作流的 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	long	调度任务的最新修改时间。	1590416703313
InstanceId	long	实例的 ID。	1234
BeginWaitResTime	long	实例任务开始等待资源的时间。	1590416703313
Bizdate	long	执行调度任务的日期。通常为该任务运行时间的前一天。	1590336000000
NodeName	string	节点的名称。	kzh
BeginWaitTimeTime	long	实例任务开始等待调度的时间。	1590416703313
NodeId	long	节点的 ID。	33115
InstanceHistoryId	long	实例的历史档案编号。	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
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史