GetManualDagInstances-DataWorks(DataWorks)-阿里云帮助中心

Queries information about instances of a manually executed business flow.

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
ProjectEnv	string	Yes	The environment identifier of the Operation Center. Valid values: PROD (production environment) and DEV (development environment). Valid values: PROD : Production environment. DEV : Development environment.	RPOD
ProjectName	string	Yes	The name of the workspace to which the manual workflow belongs. You can obtain the name on the workspace configuration page in the DataWorks console.	test_workspace
DagId	string	Yes	Instance ID of the DAG instance that triggers the manual workflow. You can call the CreateManualDag operation to obtain instance ID.	7000001231241

Response elements

Element	Type	Description	Example
	object	The response entity.
RequestId	string	The unique ID of the request.	SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF
Instances	array<object>	The list of internal instances of the manual workflow.
	object	The response entity.
Status	string	The status of the instance node. Valid values: NOT_RUN: The instance is not run. WAIT_TIME: The instance is waiting for the scheduled dueTime or cycleTime. WAIT_RESOURCE: The instance is waiting for resources. RUNNING: The instance is running. CHECKING: The instance is submitted to Data Quality for data verification. CHECKING_CONDITION: The instance is performing branch condition verification. FAILURE: The instance failed to run. SUCCESS: The instance is run successfully.	WAIT_TIME
BeginRunningTime	integer	The time when the instance node started to run. The value is a 13-digit number, for example, `1605178414676`.	1605178414676
BizDate	integer	The business date. This is typically the day before the node runs. The value is a 13-digit number, for example, `1605178414676`.	1605178414676
CycTime	integer	The scheduled time of the instance node. The value is a 13-digit number, for example, `1605178414676`.	1605178414676
FinishTime	integer	The time when the instance node finished running. The value is a 13-digit number, for example, `1605178414676`.	1605178414676
CreateTime	integer	The time when the instance node was created. The value is a 13-digit number, for example, `1605178414676`.	1605178414676
DagId	integer	The DAG ID of the manual workflow instance.	350850491
InstanceId	integer	The internal instance ID.	11726873619
BeginWaitResTime	integer	The time when the instance node started to wait for resources. The value is a 13-digit number, for example, `1605178414676`.	1605178414676
TaskType	string	The scheduling type of the instance node. 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 paused 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)
ParamValues	string	The parameter information of the instance.	xxx
DagType	string	The type of the manual workflow.	5
NodeName	string	The node name.	test2
BeginWaitTimeTime	integer	The time when the instance node started to wait for scheduling. The value is a 13-digit number, for example, `1605178414676`.	1605178414676
NodeId	integer	The internal node ID of the workflow.	37851
ModifyTime	integer	The most recent modification time of the instance node. The value is a 13-digit number, for example, `1605178414676`.	1605178414676
CreateUser	string	The operator.	xxx

Examples

Success response

JSON format

{
  "RequestId": "SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF",
  "Instances": [
    {
      "Status": "WAIT_TIME",
      "BeginRunningTime": 1605178414676,
      "BizDate": 1605178414676,
      "CycTime": 1605178414676,
      "FinishTime": 1605178414676,
      "CreateTime": 1605178414676,
      "DagId": 350850491,
      "InstanceId": 11726873619,
      "BeginWaitResTime": 1605178414676,
      "TaskType": "NORMAL(0)",
      "ParamValues": "xxx",
      "DagType": "5",
      "NodeName": "test2",
      "BeginWaitTimeTime": 1605178414676,
      "NodeId": 37851,
      "ModifyTime": 1605178414676,
      "CreateUser": "xxx"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.