ListInstanceHistory - DataWorks - Alibaba Cloud Documentation Center

Queries information about the historical records of all instances. One historical record is generated if an instance is rerun once.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	long	Yes	The instance ID. You can call the ListInstances operation to query the instance ID.	1234
ProjectEnv	string	No	The environment of the workspace. Valid values: PROD and DEV. By default, data of instances in the production environment is queried.	PROD

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	E6F0DBDD-5AD****
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Instances	array<object>	The instances.
Instances	object
Status	string	The status of the node that generates the instance. Valid values: NOT_RUN: The node is not run. WAIT_TIME: The node is waiting for the scheduling time to arrive. WAIT_RESOURCE: The node is waiting for resources. RUNNING: The node is running. CHECKING: Data quality is being checked for the node. CHECKING_CONDITION: Branch conditions are being checked for the node. FAILURE: The node fails to be run. SUCCESS: The node is successfully run.	NOT_RUN
CycTime	long	The time when the node started to be run. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	1590422400000
BeginRunningTime	long	The time when the instance started to be run. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	1590416703313
FinishTime	long	The time when the running of the node was complete. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	1590416703313
ErrorMessage	string	The error message. This parameter is deprecated. You can call the GetInstanceLog operation to query the error information related to the node.	error message
CreateTime	long	The time when the instance was generated.	1590416703313
DagId	long	The workflow ID.	33845
TaskType	string	The scheduling type of the node. Valid values: NORMAL(0): The node is an auto triggered node. The scheduling system regularly runs the node. MANUAL(1): The node is a manually triggered node. The scheduling system does not regularly run the node. PAUSE(2): The node is a frozen node. The scheduling system regularly runs the node but sets the status of the node to failed when the scheduling system starts to run the node. SKIP(3): The node is a dry-run node. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node. SKIP_UNCHOOSE(4): The node is an unselected node in a temporary workflow. This type of node exists only in temporary workflows. The scheduling system sets the status of the node to successful when the scheduling system starts to run the node. SKIP_CYCLE(5): The node is a node that is scheduled by the week or month and is waiting for the scheduling time to arrive. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node. CONDITION_UNCHOOSE(6): The node is not selected by its ancestor branch node and is run as a dry-run node. REALTIME_DEPRECATED(7): The node has instances that are generated in real time but deprecated. The scheduling system sets the status of the node to successful.	NORMAL(0)
DagType	string	Indicates whether the instance is associated with a monitoring rule in Data Quality. Valid values: 0: The instance is associated with a monitoring rule in Data Quality. 1: The instance is not associated with a monitoring rule in Data Quality.	1
ModifyTime	long	The time when the node was last modified.	1590416703313
InstanceId	long	The instance ID.	1234
BeginWaitResTime	long	The time when the instance started to wait for resources.	1590416703313
Bizdate	long	The data timestamp of the instance. In most cases, the value is one day before the time when the instance was run.	1590336000000
NodeName	string	The name of the node.	kzh
BeginWaitTimeTime	long	The time when the instance started to wait to be scheduled.	1590416703313
NodeId	long	The node ID.	33115
InstanceHistoryId	long	The historical record number of the instance.	1

Examples

Sample success responses

JSONformat

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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history