GetTaskFlowGraph - Data Management - Alibaba Cloud Documentation Center

Queries the Directed Acyclic Graph (DAG) of a task flow.

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

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
dms:GetTaskFlowGraph	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Tid	long	No	The ID of the tenant. Note To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see View information about the current tenant.	3***
DagId	long	Yes	The ID of the task flow. You can call the ListTaskFlow or ListLhTaskFlowAndScenario operation to query the task flow ID.	15***

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	D9D91166-A626-5F4E-9CA6-7AB10C59DBD8
ErrorCode	string	The error code returned if the request failed.	UnknownError
ErrorMessage	string	The error message returned if the request failed.	UnknownError
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
TaskFlowGraph	object	The list of DAG variables of the task flow.
DagName	string	The name of the task flow.	test
Nodes	array<object>	The node list of the task flow.
Node	object
DagId	long	The ID of the task flow.	15***
NodeId	long	The ID of the node.	44***
NodeName	string	The name of the node.	test
NodeType	long	The type of the node. For more information about the valid values for this parameter, see NodeType parameter.	36
NodeContent	string	The configuration of the node.	{ODI3OTNRVC****UHVFT29"}
TimeVariables	string	The time variables for the node.	{\"variables\":[{\"name\":\"Today\",\"pattern\":\"yyyy-MM-dd\|+1d\"}]}
NodeConfig	string	The advanced configuration of the node.	{\"dbId\":39***,\"dbType\":\"mysql\",\"locale\":\"zh\",\"sql\":\"/XXXXX*/\\n\\nCREATE TABLE IF NOT EXISTS `momo_weekGather` (\\n\\t`id` bigint AUTO_INCREMENT DEFAULT '0',\\n\\t`age` bit NULL,\\n\\t`action` varchar(150) NULL,\\n\\t`elapse_time` datetime NULL,\\n\\tPRIMARY KEY (`id`)\\n) ENGINE=InnoDB\\nDEFAULT CHARACTER SET=utf8;\"}
GraphParam	string	The position of the node in the DAG.	{\"x\":541,\"y\":322,\"layoutType\":\"Horizontal\"}
Edges	array<object>	The list of task flow edges.
Edge	object
DagId	long	The ID of the task flow.	15***
Id	long	The ID of the task flow edge.	24***
NodeEnd	long	The ID of the end node on the edge.	44***
NodeFrom	long	The ID of the start node on the edge.	44***
Status	long	The status of the task flow. Valid values: 0: invalid 1: not scheduled 2: to be scheduled	2
CanEdit	boolean	Indicates whether the task flow is editable. Valid values: true: editable false: non-editable	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "D9D91166-A626-5F4E-9CA6-7AB10C59DBD8",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "TaskFlowGraph": {
    "DagName": "test",
    "Nodes": {
      "Node": [
        {
          "DagId": 0,
          "NodeId": 0,
          "NodeName": "test",
          "NodeType": 36,
          "NodeContent": "{ODI3OTNRVC****UHVFT29\"}",
          "TimeVariables": "{\\\"variables\\\":[{\\\"name\\\":\\\"Today\\\",\\\"pattern\\\":\\\"yyyy-MM-dd|+1d\\\"}]}",
          "NodeConfig": "{\\\"dbId\\\":39****,\\\"dbType\\\":\\\"mysql\\\",\\\"locale\\\":\\\"zh\\\",\\\"sql\\\":\\\"/*XXXXX*/\\\\n\\\\nCREATE TABLE IF NOT EXISTS `momo_weekGather` (\\\\n\\\\t`id` bigint AUTO_INCREMENT DEFAULT '0',\\\\n\\\\t`age` bit NULL,\\\\n\\\\t`action` varchar(150) NULL,\\\\n\\\\t`elapse_time` datetime NULL,\\\\n\\\\tPRIMARY KEY (`id`)\\\\n) ENGINE=InnoDB\\\\nDEFAULT CHARACTER SET=utf8;\\\"}",
          "GraphParam": "{\\\"x\\\":541,\\\"y\\\":322,\\\"layoutType\\\":\\\"Horizontal\\\"}"
        }
      ]
    },
    "Edges": {
      "Edge": [
        {
          "DagId": 0,
          "Id": 0,
          "NodeEnd": 0,
          "NodeFrom": 0
        }
      ]
    },
    "Status": 2,
    "CanEdit": true
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history