ListDags-DataWorks(DataWorks)-阿里云帮助中心

Calls the ListDags operation to retrieve the details of all DAGs for a single data backfill instance based on the OpSeq (unique identifier of the data backfill instance).

Operation description

Dag Type values:

MANUAL: manual task workflow
SMOKE_TEST: smoke test workflow
SUPPLY_DATA: data backfill
BUSINESS_PROCESS_DAG: one-time business process workflow

Dag Status values:

CREATED: created
RUNNING: running
FAILURE: failed
SUCCESS: succeeded

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 unique identifier of the data backfill instance. You can call the GetDag operation to obtain this value.	123
ProjectEnv	string	Yes	The identifier of the scheduling O&M environment. PROD indicates the production environment, and DEV indicates the development environment. Valid values: PROD : production environment. DEV : development environment.	PROD

Response elements

Element	Type	Description	Example
	object	The response entity.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID. You can use this 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 call was successful.	true
Data	object	The details of the DAGs.
Dags	array<object>	The returned entities.
	object	The returned entity.
Type	string	The type of the DAG. Valid values: MANUAL: manual task workflow SMOKE_TEST: smoke test workflow SUPPLY_DATA: data backfill BUSINESS_PROCESS_DAG: one-time business process workflow	MANUAL_FLOW
Status	string	The status of the DAG. Valid values: CREATED: created RUNNING: running FAILURE: failed SUCCESS: succeeded	FAILURE
FinishTime	integer	The end time. The value is a 13-digit number, for example, `1605052800000`.	1605052800000
CreateTime	integer	The creation time. The value is a 13-digit number, for example, `1605052800000`.	1605052800000
ProjectId	integer	The workspace ID.	112345
DagId	integer	DagId。	351249682
Gmtdate	integer	The GMT date. The value is a 13-digit number, for example, `1605052800000`.	1605052800000
StartTime	integer	The start time. The value is a 13-digit number, for example, `1605052800000`.	1605052800000
CreateUser	string	The creator.	1736629400048545
Bizdate	integer	The business date. The value is a 13-digit number, for example, `1605052800000`.	1605052800000
Name	string	The name of the DAG.	test_dag
ModifyTime	integer	The modification time. The value is a 13-digit number, for example, `1605052800000`.	1605052800000
OpSeq	integer	The operation sequence code.	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.