ListDags - DataWorks - Alibaba Cloud Documentation Center

Queries the details of directed acyclic graphs (DAGs) for a single data backfill instance based on 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.

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
OpSeq	long	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 parameters

Parameter	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.
Dag	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	long	The end time.	1605052800000
CreateTime	long	The creation time.	1605052800000
ProjectId	long	The workspace ID.	112345
DagId	long	The DAG ID.	351249682
Gmtdate	long	The actual running time.	1605052800000
StartTime	long	The start time.	1605052800000
CreateUser	string	The creator.	1736629400048545
Bizdate	long	The data timestamp.	1605052800000
Name	string	The name of the DAG.	test_dag
ModifyTime	long	The modification time.	1605052800000
OpSeq	long	The sequence number of the operation.	123

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change time	Summary of changes	Operation

No change history