GetTaskFlowGraph - Query task flow DAG | DMS API - Data Management

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

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:GetTaskFlowGraph

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tid	integer	No	The ID of the tenant. Note To view the tenant ID, hover over the profile picture in the upper-right corner of the DMS console. View information about the current tenant.	3***
DagId	integer	Yes	The ID of the task flow. Call ListTaskFlow or ListLhTaskFlowAndScenario to query this ID.	15***

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	D9D91166-A626-5F4E-9CA6-7AB10C59DBD8
ErrorCode	string	The error code if the request failed.	UnknownError
ErrorMessage	string	The error message if the request failed.	UnknownError
Success	boolean	Whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
TaskFlowGraph	object	The DAG graph of the task flow.
DagName	string	The name of the task flow.	test
Nodes	object
Node	array<object>	The nodes in the task flow.
	object
DagId	integer	The ID of the task flow.	15***
NodeId	integer	The ID of the node.	44***
NodeName	string	The name of the node.	test
NodeType	integer	The node type. NodeType parameter.	NORMAL_SQL
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\":\"/ Make sure the following SQL meets your requirements before you submit it for execution */\\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	object
Edge	array<object>	The edges in the task flow.
	object
DagId	integer	The ID of the task flow.	15***
Id	integer	The ID of the task flow edge.	24***
NodeEnd	integer	The ID of the target node on the edge.	44***
NodeFrom	integer	The ID of the source node on the edge.	44***
Status	integer	The status of the task flow. Valid values: 0: invalid 1: not scheduled 2: to be scheduled	2
CanEdit	boolean	Whether the task flow is editable. Valid values: true: editable false: non-editable	true

Examples

Success response

JSON format

{
  "RequestId": "D9D91166-A626-5F4E-9CA6-7AB10C59DBD8",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "TaskFlowGraph": {
    "DagName": "test",
    "Nodes": {
      "Node": [
        {
          "DagId": 0,
          "NodeId": 0,
          "NodeName": "test",
          "NodeType": 0,
          "NodeContent": "{ODI3OTNRVC****UHVFT29\"}",
          "TimeVariables": "{\\\"variables\\\":[{\\\"name\\\":\\\"Today\\\",\\\"pattern\\\":\\\"yyyy-MM-dd|+1d\\\"}]}",
          "NodeConfig": "{\\\"dbId\\\":39****,\\\"dbType\\\":\\\"mysql\\\",\\\"locale\\\":\\\"zh\\\",\\\"sql\\\":\\\"/* Make sure the following SQL meets your requirements before you submit it for execution */\\\\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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.