Queries the information about instances in a manually triggered workflow.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListManualDagInstances

The operation that you want to perform.

DagId String Yes 7000001231241

The ID of the directed acyclic graph (DAG) for the manually triggered workflow. You can call the CreateManualDag operation to obtain the ID.

ProjectEnv String Yes RPOD

The environment type. Valid values: PROD and DEV. The value PROD indicates the production environment. The value DEV indicates the development environment.

ProjectName String Yes test_workspace

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 Management page to obtain the ID.

RegionId String Yes cn-shanghai

The region ID. For example, the ID of the China (Shanghai) region is cn-shanghai, and that of the China (Zhangjiakou) region is cn-zhangjiakou. The system automatically determines the value of this parameter based on the endpoint used to call the operation.

Response parameters

Parameter Type Example Description
Instances Array of Instances

An array of instances involved in the manually triggered workflow.

BeginRunningTime Long 1605178414676

The time when the instance started to run.

BeginWaitResTime Long 1605178414676

The time when the instance started to wait for resources.

BeginWaitTimeTime Long 1605178414676

The time when the instance started to wait to be run.

BizDate Long 1605178414676

The data timestamp. In most cases, the value is one day before the date when the instance is run.

CreateTime Long 1605178414676

The time when the instance was created.

CycTime Long 1605178414676

The time when the instance was scheduled to run.

DagId Long 350850491

The ID of the DAG for the manually triggered workflow.

DagType String 5

The identifier of the manually triggered workflow.

FinishTime Long 1605178414676

The time when the running of the instance was complete.

InstanceId Long 11726873619

The ID of the instance.

ModifyTime Long 1605178414676

The time when the instance was last modified.

NodeId Long 37851

The ID of the node in the workflow.

NodeName String test2

The name of the node.

ParamValues String xxx=yyy

The parameter settings of the instance.

Status String SUCCESS

The status of the instance. Valid values:

  • NOT_RUN: The instance is not run.
  • WAIT_TIME: The instance is waiting for its scheduled 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 running of the instance is successful.
TaskType String MANUAL

The scheduling type of the instance. Valid values:

  • NORMAL(0): The instance is an auto triggered node instance. It is run on a regular basis.
  • MANUAL(1): The instance is a manually triggered node instance. It is not run on a regular basis.
  • PAUSE(2): The instance is paused. The scheduling system still runs the instance but sets it to FAILURE when the scheduling system starts to run the instance.
  • SKIP(3): The instance is a dry-run instance. The scheduling system still runs the instance but sets it to SUCCESS when the scheduling system starts to run the instance.
  • SKIP_UNCHOOSE(4): The instance is an unselected instance in a temporary workflow. This type of instance exists only in temporary workflows. The scheduling system sets the instance to SUCCESS when the scheduling system starts to run the instance.
  • SKIP_CYCLE(5): The instance is a weekly or monthly instance whose running cycle does not arrive. The scheduling system still runs the instance but sets it to SUCCESS when the scheduling system starts to run the instance.
  • CONDITION_UNCHOOSE(6): The instance is not selected by its ancestor branch node instance and is set to a dry-run instance.
  • REALTIME_DEPRECATED(7): The instance is generated in real time but is deprecated. The scheduling system directly sets it to SUCCESS.
RequestId String SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF

The ID of the request. You can use the ID to locate logs and troubleshoot issues.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListManualDagInstances
&DagId=7000001231241
&ProjectEnv=RPOD
&ProjectName=test_workspace
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

<Instances>
    <Status>SUCCESS</Status>
    <ModifyTime>1605178414676</ModifyTime>
    <NodeName>test2</NodeName>
    <DagType>5</DagType>
    <InstanceId>11726873619</InstanceId>
    <ParamValues>xxx=yyy</ParamValues>
    <CreateTime>1605178414676</CreateTime>
    <BeginWaitTimeTime>1605178414676</BeginWaitTimeTime>
    <CycTime>1605178414676</CycTime>
    <DagId>350850491</DagId>
    <BeginRunningTime>1605178414676</BeginRunningTime>
    <FinishTime>1605178414676</FinishTime>
    <TaskType>MANUAL</TaskType>
    <NodeId>37851</NodeId>
    <BeginWaitResTime>1605178414676</BeginWaitResTime>
    <BizDate>1605178414676</BizDate>
</Instances>
<RequestId>SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF</RequestId>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.