GetDag - DataWorks - Alibaba Cloud Documentation Center

Queries the information about a directed acyclic graph (DAG). You can call the GetDag operation to query the information about the DAG for a manually triggered workflow, a manually triggered node, or a data backfill instance. However, you cannot query the information about the DAG for an auto triggered node or an auto triggered workflow.

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
RUNNING
FAILURE
SUCCESS

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
dataworks:*	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
DagId	long	Yes	The ID of the DAG. You can use one of the following method to obtain the ID: Call the RunCycleDagNodes operation and obtain the value of the Data response parameter. Call the RunSmokeTest operation and obtain the value of the Data response parameter. Call the RunManualDagNodes operation and obtain the value of the DagId response parameter.	123141452344525
ProjectEnv	string	Yes	The environment of the workspace. Valid values: PROD and DEV.	PROD

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	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 the DAG.
Type	string	The type of the DAG. Valid values: MANUAL, SMOKE_TEST, SUPPLY_DATA, and BUSINESS_PROCESS_DAG. The value MANUAL indicates the DAG for a manually triggered workflow. The value SMOKE_TEST indicates the DAG for a smoke testing workflow. The value SUPPLY_DATA indicates the DAG for a data backfill instance. The value BUSINESS_PROCESS_DAG indicates the DAG for a one-time workflow.	MANUAL_FLOW
Status	string	The status of the DAG. Valid values: CREATED, RUNNING, FAILURE, and SUCCESS.	FAILURE
FinishTime	long	The time when the DAG finished running.	1605052800000
CreateTime	long	The time when the DAG was created.	1605052800000
ProjectId	long	The workspace ID.	112345
DagId	long	The DAG ID.	351249682
Gmtdate	long	The time when the DAG was scheduled to run.	1605052800000
StartTime	long	The time when the DAG started to run.	1605052800000
CreateUser	string	The creator.	1736629400048545
Bizdate	long	The data timestamp.	1605052800000
Name	string	The name of the DAG.	test_dag
ModifyTime	long	The time when the DAG was last modified.	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": {
    "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