Queries 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.

RegionId String Yes cn-shanghai

The ID of the region in which the DataWorks workspace resides. 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 that is used to call the operation.

ProjectEnv String Yes RPOD

The environment of the workspace. Valid values: PROD and DEV. A value of PROD indicates the production environment. A value of 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 view the name.

DagId String Yes 7000001231241

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

Response parameters

Parameter Type Example Description
RequestId String SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF

The ID of the request. You can use the ID to search for logs and troubleshoot issues based on the logs.

Instances Array of Instances

The instances in the manually triggered workflow.

Status String SUCCESS

The status of the node. Valid values:

  • NOT_RUN: The node is not run.
  • WAIT_TIME: The node is waiting for its scheduled 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 run.
  • SUCCESS: The node is run as expected.
BeginRunningTime Long 1605178414676

The time when the node started to run. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

BizDate Long 1605178414676

The data timestamp of the instance. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. In most cases, the value indicates one day before the time when the node was run.

CycTime Long 1605178414676

The time when the node was scheduled to run. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

FinishTime Long 1605178414676

The time when the node stopped running. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

CreateTime Long 1605178414676

The time when the node was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

DagId Long 350850491

The ID of the DAG for the manually triggered workflow.

InstanceId Long 11726873619

The ID of the instance in the manually triggered workflow.

BeginWaitResTime Long 1605178414676

The time when the node started to wait for resources. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

TaskType String MANUAL

The scheduling type of the node. Valid values:

  • NORMAL(0): The node is an auto triggered node. It is run on a regular basis.
  • MANUAL(1): The node is a manually triggered node. It is not run on a regular basis.
  • PAUSE(2): The node is a frozen node. The scheduling system still runs the node on a regular basis but sets it to Failed when the scheduling system starts to run the node.
  • SKIP(3): The node is a dry-run node. The scheduling system still runs the node on a regular basis but sets it to Succeeded 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 node to Succeeded 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 its scheduled time. The scheduling system still runs the node on a regular basis but sets it to Succeeded 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 generated in real time but deprecated. The scheduling system directly sets the node to Succeeded.
ParamValues String xxx=yyy

The parameters related to the instance.

DagType String 5

The identifier of the manually triggered workflow.

NodeName String test2

The name of the node.

BeginWaitTimeTime Long 1605178414676

The time when the node started to wait to be scheduled. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

NodeId Long 37851

The ID of the node in the manually triggered workflow.

ModifyTime Long 1605178414676

The time when the node was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

CreateUser String Test

The name of the account used to run the instance. For example, if an account named Test was used to run the instance to backfill data, the value of this parameter is Test.

Examples

Sample requests

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

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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 API Error Center.