Call ListDags to query details of DAGs - DataWorks - Alibaba Cloud - DataWorks

Retrieves a list of directed acyclic graphs (DAGs) for a data backfill instance by operation sequence number (OpSeq).

Operation description

Supported DAG types:

MANUAL: DAG for a manually triggered workflow
SMOKE_TEST: DAG for a smoke testing workflow
SUPPLY_DATA: DAG for a data backfill instance
BUSINESS_PROCESS_DAG: DAG for a one-time workflow

Supported DAG states:

CREATED: The DAG is created.
RUNNING: The DAG is running.
FAILURE: The DAG fails to run.
SUCCESS: The DAG is successfully run.

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
OpSeq	integer	Yes	The sequence number that uniquely identifies the data backfill operation. You can call the GetDag operation to query the sequence number.	123
ProjectEnv	string	Yes	The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment, and the value DEV indicates the development environment.	PROD

Response elements

Element	Type	Description	Example
	object	The returned result.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID. You can use the ID to locate logs and troubleshoot issues.	7782a299-b291-4fee-8424-cf8058efa8e8
ErrorMessage	string	The error message.	The connection does not exist.
ErrorCode	string	The error code.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indicates whether the request was successful.	true
Data	object	The details of DAGs.
Dags	array<object>	The entities returned.
	object
Type	string	The type of the DAG. Valid values: MANUAL: DAG for a manually triggered workflow SMOKE_TEST: DAG for a smoke testing workflow SUPPLY_DATA: DAG for a data backfill instance BUSINESS_PROCESS_DAG: DAG for a one-time workflow	MANUAL_FLOW
Status	string	The status of the DAG. Valid values: CREATED RUNNING FAILURE SUCCESS	FAILURE
FinishTime	integer	The end time.	1605052800000
CreateTime	integer	The creation time.	1605052800000
ProjectId	integer	The workspace ID.	112345
DagId	integer	The DAG ID.	351249682
Gmtdate	integer	The actual running time.	1605052800000
StartTime	integer	The start time.	1605052800000
CreateUser	string	The creator.	1736629400048545
Bizdate	integer	The data timestamp.	1605052800000
Name	string	The name of the DAG.	test_dag
ModifyTime	integer	The modification time.	1605052800000
OpSeq	integer	The sequence number of the operation.	123

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "7782a299-b291-4fee-8424-cf8058efa8e8",
  "ErrorMessage": "The connection does not exist.",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "Dags": [
      {
        "Type": "MANUAL_FLOW",
        "Status": "FAILURE",
        "FinishTime": 1605052800000,
        "CreateTime": 1605052800000,
        "ProjectId": 112345,
        "DagId": 351249682,
        "Gmtdate": 1605052800000,
        "StartTime": 1605052800000,
        "CreateUser": "1736629400048545",
        "Bizdate": 1605052800000,
        "Name": "test_dag",
        "ModifyTime": 1605052800000,
        "OpSeq": 123
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.