ListInstanceHistory API for querying instance history - DataWorks - Alibaba Cloud - DataWorks

Retrieves all history records of an instance. A history record is generated each time a node is rerun.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	integer	Yes	The ID of the instance. You can call ListInstances to obtain the ID.	1234
ProjectEnv	string	No	The environment of the workspace. Valid values: PROD (production environment) and DEV (development environment). Default value: PROD.	PROD

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID. Used to locate logs and troubleshoot issues.	E6F0DBDD-5AD****
Success	boolean	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	true
Instances	array<object>	The list of instances.
	object	The instance details.
Status	string	The status of the node. Valid values: NOT_RUN: The node is not run. WAIT_TIME: The node is waiting for the scheduled time (DueTime or CycTime) to arrive. WAIT_RESOURCE: The node is waiting for resources. RUNNING: The node is running. CHECKING: The node is sent to Data Quality for data verification. CHECKING_CONDITION: The node is undergoing branch condition verification. FAILURE: The node failed to run. SUCCESS: The node ran successfully.	NOT_RUN
CycTime	integer	The scheduled run time of the node, in timestamp format.	1590422400000
BeginRunningTime	integer	The time when the instance started running, in timestamp format.	1590416703313
FinishTime	integer	The time when the scheduled node finished running, in timestamp format.	1590416703313
ErrorMessage	string	[Deprecated] The error message returned when the instance failed to run. This field is deprecated. You can call the GetInstanceLog operation to obtain the error information of the node.	error message
CreateTime	integer	The time when the instance was created. The value is a 13-digit number, such as `1590416703313`.	1590416703313
DagId	integer	The ID of the workflow.	33845
TaskType	string	The scheduling type of the node instance. Valid values: NORMAL(0): A normal scheduling node. The node is scheduled on a daily basis. MANUAL(1): A manual node. The node is not scheduled on a daily basis. PAUSE(2): A frozen node. The node is scheduled on a daily basis, but is set to failed when scheduling starts. SKIP(3): A dry-run node. The node is scheduled on a daily basis, but is set to successful when scheduling starts. SKIP_UNCHOOSE(4): A node that is not selected in a temporary workflow. This type of node exists only in temporary workflows and is set to successful when scheduling starts. SKIP_CYCLE(5): A weekly or monthly node that has not reached its run cycle. The node is scheduled on a daily basis, but is set to successful when scheduling starts. CONDITION_UNCHOOSE(6): A downstream node that is not selected by an upstream branch (IF) node. The node is directly set to dry-run. REALTIME_DEPRECATED(7): An expired periodic instance generated in real time. This type of node is directly set to successful.	NORMAL(0)
DagType	string	The Data Quality Check (DQC) type. Valid values: 0: associated with DQC. 1: not associated with DQC.	1
ModifyTime	integer	The time when the scheduled node was last modified. The value is a 13-digit number, such as `1590416703313`.	1590416703313
InstanceId	integer	The ID of the instance.	1234
BeginWaitResTime	integer	The time when the instance started waiting for resources. The value is a 13-digit number, such as `1590416703313`.	1590416703313
Bizdate	integer	The business date on which the scheduled node was run. This value is typically one day before the run time of the node. The value is a 13-digit number, such as `1590336000000`.	1590336000000
NodeName	string	The name of the node.	kzh
BeginWaitTimeTime	integer	The time when the instance started waiting for scheduling. The value is a 13-digit number, such as `1590416703313`.	1590416703313
NodeId	integer	The ID of the node.	33115
InstanceHistoryId	integer	The history archive ID of the instance.	1

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.