Call GetDag to obtain the Dag details based on DagId. The GetDag operation can query Dag details for manually triggered workflow, one-time tasks, and retroactive data generation tasks, but does not query Dag details for routine scheduling.

The Type of the Dag Type:

MANUAL: indicates that the workflow is MANUAL.

SMOKE_TEST: Smoke testing a workflow.

Reply_data: Retroactive data generation

BUSINESS_PROCESS_DAG: Workflow one-time workflow

The type of the Dag Status:

CREATED: The message is CREATED.

RUNNING

FAILURE

SUCCESS

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetDag

The operation that you want to perform.

DagId Long Yes 123141452344525

A DagId can be used as a CreateDagComplement to perform a retroactive test, a CreateTest test, or a manually triggered workflow CreateManualDag.

ProjectEnv String Yes PROD

Identifier of the scheduling environment: in this example, PROD indicates the production environment, and DEV indicates the development environment.

RegionId String Yes cn-shanghai

The region ID of the workspace.

Response parameters

Parameter Type Example Description
Data Struct

The details of the Dag.

Bizdate Long 1605052800000

The data timestamp of the node instance.

CreateTime Long 1605052800000

The time when the RAM user group was created.

CreateUser String 1736629400048545

The user who created the node instance.

DagId Long 351249682

DagId.

FinishTime Long 1605052800000

The end time.

Gmtdate Long 1605052800000

Gmtdate.

ModifyTime Long 1605052800000

The time when the launch template was modified.

Name String test_dag

The Dag name.

ProjectId Long 112345

The ID of the DataWorks workspace.

StartTime Long 1605052800000

The start time.

Status String FAILURE

The DAG status includes CREATED, RUNNING, FAILURE, and SUCCESS.

Type String MANUAL_FLOW

The DAG type. Valid values: MANUAL, Smoke testing, BUSINESS_PROCESS_DAG, and workflow.

ErrorCode String Invalid.Tenant.ConnectionNotExists

The error code.

ErrorMessage String The connection does not exist.

The error message.

HttpStatusCode Integer 200

The HTTP status code.

RequestId String 7782a299-b291-4fee-8424-cf8058efa8e8

The ID of the request. It is used to locate logs and troubleshoot problems.

Success Boolean true

Indicates whether the request was successful.

Examples

Sample requests


     http(s)://[Endpoint]/? Action=GetDag &DagId=123141452344525 &RegionId=cn-shanghai &<common request parameters> 
   

Sample success responses

XML format


     <success>true</success> <httpStatusCode>200</httpStatusCode> <data> <projectId>33679</projectId> <dagId>351249682</dagId> <name>aadasdfasdfasdf</name> <type>MANUAL_FLOW</type> <status>FAILURE</status> <bizdate>1605052800000</bizdate> <gmtdate>1605139200000 <startTime>1605211837166</startTime> <finishTime>1605211837282</finishTime> <createTime>1605211377024</createTime> <createUser>1736629400048545</createUser> <modifyTime>1605211837282</modifyTime> </data> <requestId>7782a299-b291-4fee-8424-cf8058efa8e8</requestId> 
   

JSON Hint


     { "success": true, "httpStatusCode": 200, "data": { "projectId": 33679, "dagId": 351249682, "name": "aadasdfasdfasdf", "type": "MANUAL_FLOW", "status": "FAILURE", "bizdate": 1605052800000, "gmtdate": 1605139200000, "startTime": 1605211837166, "finishTime": 1605211837282, "createTime": 1605211377024, "createUser": "1736629400048545", "modifyTime": 1605211837282 }, "requestId": "7782a299-b291-4fee-8424-cf8058efa8e8" } 
   

Error codes

Go to the Error CenterFor more information, see error codes.