GetManualDagInstances

更新时间:
复制 MD 格式

Queries the information about instances in a manually triggered workflow.

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 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 Settings panel to query the name.

test_workspace

DagId

string

Yes

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

7000001231241

Response elements

Element

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.

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.

WAIT_TIME

BeginRunningTime

integer

The time when the instance started to run.

1605178414676

BizDate

integer

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

1605178414676

CycTime

integer

The time when the instance was scheduled to run.

1605178414676

FinishTime

integer

The time when the instance finished running.

1605178414676

CreateTime

integer

The time when the instance was generated.

1605178414676

DagId

integer

The ID of the DAG for the manually triggered workflow.

350850491

InstanceId

integer

The ID of the instance in the manually triggered workflow.

11726873619

BeginWaitResTime

integer

The time when the instance started to wait for resources.

1605178414676

TaskType

string

The scheduling type of the node that generates the instance. 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 paused 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.

NORMAL(0)

ParamValues

string

The parameters related to the instance.

xxx

DagType

string

The type of the manually triggered workflow.

5

NodeName

string

The name of the node.

test2

BeginWaitTimeTime

integer

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

1605178414676

NodeId

integer

The ID of the node in the manually triggered workflow.

37851

ModifyTime

integer

The time when the instance was last modified.

1605178414676

CreateUser

string

The user who performed the operation.

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.