ListManualDagInstances - DataWorks - Alibaba Cloud Documentation Center

Queries the information about instances in a manually triggered workflow.

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

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dataworks:*	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ProjectEnv	string	Yes	The environment of Operation Center. Valid values: PROD and DEV.	RPOD
ProjectName	string	Yes	The name of the workspace to which the manually triggered workflow belongs. You can log on to the DataWorks console and go to the Workspace page to obtain the name.	test_workspace
DagId	string	Yes	The ID of the directed acyclic graph (DAG) for the manually triggered workflow. You can call the RunManualDagNodes operation to obtain the ID.	7000001231241

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF
Instances	array<object>	The instances in the manually triggered workflow.
Instances	object
Status	string	The status of the instance. Valid values: NOT_RUN: The instance is not run. WAIT_TIME: The instance is waiting for its scheduling time to arrive. WAIT_RESOURCE: The instance is waiting for resources. RUNNING: The instance is running. CHECKING: Data quality is being checked for the instance. CHECKING_CONDITION: Branch conditions are being checked for the instance. FAILURE: The instance fails to be run. SUCCESS: The instance is successfully run.	SUCCESS
BeginRunningTime	long	The time when the instance started to run.	1605178414676
BizDate	long	The data timestamp of the instance. In most cases, the value is one day before the time when the instance was run.	1605178414676
CycTime	long	The time when the instance was scheduled to run.	1605178414676
FinishTime	long	The time when the instance finished running.	1605178414676
CreateTime	long	The time when the instance was generated.	1605178414676
DagId	long	The ID of the DAG for the instance in the manually triggered workflow.	350850491
InstanceId	long	The instance ID.	11726873619
BeginWaitResTime	long	The time when the instance started to wait for resources.	1605178414676
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 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.	MANUAL
ParamValues	string	The parameters related to the instance.	xxx=yyy
DagType	string	The type of the manually triggered workflow.	5
NodeName	string	The name of the node.	test2
BeginWaitTimeTime	long	The time when the instance started to wait to be scheduled.	1605178414676
NodeId	long	The ID of the node in the manually triggered workflow.	37851
ModifyTime	long	The time when the instance was last modified.	1605178414676
CreateUser	string	The name of the account that is used to run the instance. For example, if you use an account named Test to run the instance, the value of this parameter is Test.	Test

Examples

Sample success responses

JSONformat

{
  "RequestId": "SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF",
  "Instances": [
    {
      "Status": "SUCCESS",
      "BeginRunningTime": 1605178414676,
      "BizDate": 1605178414676,
      "CycTime": 1605178414676,
      "FinishTime": 1605178414676,
      "CreateTime": 1605178414676,
      "DagId": 350850491,
      "InstanceId": 11726873619,
      "BeginWaitResTime": 1605178414676,
      "TaskType": "MANUAL",
      "ParamValues": "xxx=yyy",
      "DagType": "5",
      "NodeName": "test2",
      "BeginWaitTimeTime": 1605178414676,
      "NodeId": 37851,
      "ModifyTime": 1605178414676,
      "CreateUser": "Test"
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-06-25	The internal configuration of the API is changed, but the call is not affected	View Change Details