All Products
Search
Document Center

DataWorks:ListInstances

Last Updated:Nov 21, 2024

The ID of the directed acyclic graph (DAG). You can set this parameter to the value of the DagId parameter returned by the \[RunCycleDagNodes]\(~~212961~~), \[RunSmokeTest]\(~~212949~~), or \[RunManualDagNodes]\(~~212830~~) operation based on your business requirements. The RunManualDagNodes operation is used to backfill data, the RunSmokeTest operation is used to perform smoke testing, and the RunManualDagNodes operation is used to run nodes 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
dataworks:*list
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectEnvstringYes

The time when the node was last modified.

Enumeration Value:
  • PROD
  • DEV
PROD
NodeIdlongYes

Indicates whether the instance is associated with a monitoring rule in Data Quality. Valid values:

  • 0: The instance is associated with a monitoring rule in Data Quality.
  • 1: The instance is not associated with a monitoring rule in Data Quality.
100000000000
NodeNamestringNo

Indicates whether the node can be rerun.

openmr_8****
OwnerstringNo

The connection string.

193379****
ProjectIdlongYes

The ID of the baseline.

12345
BizNamestringNo

The ID of the instance.

test_bizName
ProgramTypestringNo

The error code returned.

ODPS_SQL
PageNumberintegerNo

The operation that you want to perform.

1
PageSizeintegerNo

The ID of the node.

10
DagIdlongNo

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

11111
BizdatestringNo

The number of entries returned per page. Default value: 10. Maximum value: 100.

2020-02-02 00:00:00
BeginBizdatestringNo

The parameters related to the node.

2020-02-02 00:00:00
EndBizdatestringNo

The ID of the workflow.

2020-02-03 00:00:00
StatusstringNo

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

Enumeration Value:
  • SUCCESS
  • FAILURE
  • WAIT_TRIGGER
  • CHECKING
  • RUNNING
  • WAIT_RESOURCE
  • WAIT_TIME
  • NOT_RUN
NOT_RUN

Response parameters

ParameterTypeDescriptionExample
object

The instances returned.

HttpStatusCodeinteger

The error message that is returned for the instance.

This parameter is deprecated. You can call the GetInstanceLog operation to query the error information related to the node.

200
RequestIdstring

The name of the node.

E6F0DBDD-5AD****
ErrorMessagestring

The page number of the returned page.

The project does not exist.
ErrorCodestring

The HTTP status code returned.

Invalid.Tenant.ProjectNotExists
Successboolean

The beginning of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format.

true
Dataobject

The ID of the node. You can call the ListNodes operation to query the ID of the node.

PageNumberinteger

The time when the node was scheduled to run.

1
PageSizeinteger

The end of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format.

10
TotalCountinteger

The priority of the instance. Valid values: 1, 3, 5, 7, and 8.

A greater value indicates a higher priority. Default value: 1.

66
Instancesarray<object>

The name of the node. You can call the ListNodes operation to query the name of the node.

Instanceobject

The time when the instance was generated.

Statusstring

The data timestamp of the instances that you want to query. Specify the timestamp in the yyyy-MM-dd HH:mm:ss format.

NOT_RUN
CycTimelong

The error message returned.

1590422400000
BeginRunningTimelong

The time when the instance started to run.

1590416703313
FinishTimelong

The ID of the Alibaba Cloud account used by the workspace administrator. You can log on to the Alibaba Cloud Management Console and view the ID on the Security Settings page of the Account Center console.

1590416703313
ErrorMessagestring

The name of the account that is 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.

error message
CreateTimelong

The interval at which the node is rerun after the node fails to run. Unit: milliseconds.

1590416703313
DagIdlong

The time when the instance started to wait for resources.

33845
Priorityinteger

The total number of instances.

1
TaskTypestring

The information about the instances.

NORMAL(0)
ParamValuesstring

The table and partition filter expression in Data Quality that are associated with the node.

bizdate=$bizdate tbods=$tbods
Connectionstring

The number of times the node can be rerun. The value of this parameter can be empty or an integer that is greater than or equal to 0.

  • If the value of this parameter is empty, the number of times that the node can be rerun is not specified.
  • If the value of this parameter is 0, the node cannot be rerun.
  • If the value of this parameter is a positive integer such as n, the node can be rerun n times. For example, if the value of this parameter is 1, the node can be rerun once. If the value of this parameter is 2, the node can be rerun twice.
odps_first
BaselineIdlong

The type of the workflow. Valid values:

  • DAILY: The workflow is used to run auto triggered nodes.
  • MANUAL: The workflow is used to run manually triggered nodes.
  • SMOKE_TEST: The workflow is used to perform smoke testing.
  • SUPPLY_DATA: The workflow is used to backfill data.
123123
DqcTypeinteger

The status of the node. Valid values:

  • NOT_RUN: The node is not run.
  • WAIT_TIME: The node is waiting for the scheduling 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 successfully run.
1
DagTypestring

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

DAILY
BusinessIdlong

The ID of the workflow to which the node belongs.

123
TaskRerunTimeinteger

The ID of the workspace. You can call the ListProjects operation to query the ID of the workspace.

0
ModifyTimelong

The name of the workflow. You can call the ListBusiness operation to query the name of the workflow.

1590416703313
Repeatabilityboolean

The status of the node. Valid values:

  • NOT_RUN: The node is not run.
  • WAIT_TIME: The node is waiting for the scheduling 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 successfully run.
true
RepeatIntervallong

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 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 status of 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 the scheduling time to arrive. The scheduling system regularly runs the node but sets the status of the node 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 that are generated in real time but deprecated. The scheduling system sets the status of the node to succeeded.

60000
InstanceIdlong

The number of the page to return. Minimum value:1. Maximum value: 100.

1234
BeginWaitResTimelong

The time when the node stopped running.

1590416703313
RelatedFlowIdlong

The type of the node. You can call the ListNodes operation to query the type of the node.

123456
Bizdatelong

The number of entries to return on each page. Default value: 10. Maximum value: 100.

You cannot specify the sorting method for the instances to be returned by this operation. By default, the instances are sorted in descending order of the time when the instances were created.

1590336000000
NodeNamestring

The ID of the workflow.

kzh
BeginWaitTimeTimelong

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

1590416703313
DqcDescriptionstring

The operation that you want to perform.

[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]
NodeIdlong

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

33115
CreateUserstring

The ID of the node. You can call the ListNodes operation to query the ID of the node.

Test

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "RequestId": "E6F0DBDD-5AD****",
  "ErrorMessage": "The project does not exist.",
  "ErrorCode": "Invalid.Tenant.ProjectNotExists",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 66,
    "Instances": [
      {
        "Status": "NOT_RUN",
        "CycTime": 1590422400000,
        "BeginRunningTime": 1590416703313,
        "FinishTime": 1590416703313,
        "ErrorMessage": "error message",
        "CreateTime": 1590416703313,
        "DagId": 33845,
        "Priority": 1,
        "TaskType": "NORMAL(0)",
        "ParamValues": "bizdate=$bizdate tbods=$tbods",
        "Connection": "odps_first",
        "BaselineId": 123123,
        "DqcType": 1,
        "DagType": "DAILY",
        "BusinessId": 123,
        "TaskRerunTime": 0,
        "ModifyTime": 1590416703313,
        "Repeatability": true,
        "RepeatInterval": 60000,
        "InstanceId": 1234,
        "BeginWaitResTime": 1590416703313,
        "RelatedFlowId": 123456,
        "Bizdate": 1590336000000,
        "NodeName": "kzh",
        "BeginWaitTimeTime": 1590416703313,
        "DqcDescription": "[{\"projectName\":\"ztjy_dim\",\"tableName\":\"dim_user_agent_manage_area_a\",\"partition\":\"ds\\u003d$[yyyy-mm-dd-1]\"}]",
        "NodeId": 33115,
        "CreateUser": "Test"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-12-07The request parameters of the API has changedView Change Details