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

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 GetTaskFlowGraph

The operation that you want to perform. Set the value to GetTaskFlowGraph.

Tid Long No 3***

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.
DagId Long Yes 15***

The ID of the task flow. You can call the ListTaskFlow or ListLhTaskFlowAndScenario operation to query the task flow ID.

Response parameters

Parameter Type Example Description
RequestId String D9D91166-A626-5F4E-9CA6-7AB10C59DBD8

The ID of the request.

ErrorCode String UnknownError

The error code returned if the request failed.

ErrorMessage String UnknownError

The error message returned if the request failed.

Success Boolean true

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
TaskFlowGraph Object

The list of DAG variables of the task flow.

DagName String test

The name of the task flow.

Nodes Array of Node

The node list of the task flow.

Node
DagId Long 15***

The ID of the task flow.

NodeId Long 44***

The ID of the node.

NodeName String test

The name of the node.

NodeType Long 36

The type of the node. For more information about the valid values for this parameter, see NodeType parameter.

NodeContent String {ODI3OTNRVC****UHVFT29"}

The configuration of the node.

TimeVariables String {\"variables\":[{\"name\":\"Today\",\"pattern\":\"yyyy-MM-dd|+1d\"}]}

The time variables for the node.

NodeConfig String {\"dbId\":39****,\"dbType\":\"mysql\",\"locale\":\"zh\",\"sql\":\"/* Make sure that the following SQL statements meet your change requirements before you submit them 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;\"}

The advanced configuration of the node.

GraphParam String {\"x\":541,\"y\":322,\"layoutType\":\"Horizontal\"}

The position of the node in the DAG.

Edges Array of Edge

The list of task flow edges.

Edge
DagId Long 15***

The ID of the task flow.

Id Long 24***

The ID of the task flow edge.

NodeEnd Long 44***

The ID of the end node on the edge.

NodeFrom Long 44***

The ID of the start node on the edge.

Status Long 2

The status of the task flow. Valid values:

  • 0: invalid
  • 1: not scheduled
  • 2: to be scheduled
CanEdit Boolean true

Indicates whether the task flow is editable. Valid values:

  • true: editable
  • false: non-editable

Examples

Sample requests

http(s)://dms-enterprise.aliyuncs.com/?Action=GetTaskFlowGraph
&DagId=15***
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<GetTaskFlowGraphResponse>
    <RequestId>D9D91166-A626-5F4E-9CA6-7AB10C59DBD8</RequestId>
    <TaskFlowGraph>
        <Status>2</Status>
        <DagName>testSpark</DagName>
        <CanEdit>true</CanEdit>
        <Edges>
        </Edges>
        <Nodes>
            <Node>
                <NodeName>Lindorm Spark-1</NodeName>
                <TimeVariables>{"variables":[{"name":"my_bizdate","pattern":"yyyy-MM-dd|+6d"}]}</TimeVariables>
                <NodeType>LINDORM_SPARK</NodeType>
                <NodeId>44***</NodeId>
                <DagId>15***</DagId>
                <NodeContent>ODI3OTNRVC****UHVFT29</NodeContent>
                <GraphParam>{"x":254,"y":239,"layoutType":"Horizontal"}</GraphParam>
            </Node>
            <Node>
                <NodeName>Lindorm Spark-2</NodeName>
                <NodeType>LINDORM_SPARK</NodeType>
                <NodeId>44***</NodeId>
                <DagId>15***</DagId>
                <GraphParam>{"x":538,"y":161,"layoutType":"Horizontal"}</GraphParam>
            </Node>
            <Node>
                <NodeName>Lindorm Spark-3</NodeName>
                <NodeType>LINDORM_SPARK</NodeType>
                <NodeId>44***</NodeId>
                <DagId>15***</DagId>
                <GraphParam>{"x":541,"y":322,"layoutType":"Horizontal"}</GraphParam>
            </Node>
        </Nodes>
    </TaskFlowGraph>
    <Success>true</Success>
</GetTaskFlowGraphResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "D9D91166-A626-5F4E-9CA6-7AB10C59DBD8",
  "TaskFlowGraph" : {
    "Status" : 2,
    "DagName" : "testSpark",
    "CanEdit" : true,
    "Edges" : {
      "Edge" : [ ]
    },
    "Nodes" : {
      "Node" : [ {
        "NodeName" : "Lindorm Spark-1",
        "TimeVariables" : "{\"variables\":[{\"name\":\"my_bizdate\",\"pattern\":\"yyyy-MM-dd|+6d\"}]}",
        "NodeType" : "LINDORM_SPARK",
        "NodeId" : "44***",
        "DagId" : "15***",
        "NodeContent" : "ODI3OTNRVC****UHVFT29",
        "GraphParam" : "{\"x\":254,\"y\":239,\"layoutType\":\"Horizontal\"}"
      }, {
        "NodeName" : "Lindorm Spark-2",
        "NodeType" : "LINDORM_SPARK",
        "NodeId" : "44***",
        "DagId" : "15***",
        "GraphParam" : "{\"x\":538,\"y\":161,\"layoutType\":\"Horizontal\"}"
      }, {
        "NodeName" : "Lindorm Spark-3",
        "NodeType" : "LINDORM_SPARK",
        "NodeId" : "44***",
        "DagId" : "15***",
        "GraphParam" : "{\"x\":541,\"y\":322,\"layoutType\":\"Horizontal\"}"
      } ]
    }
  },
  "Success" : true
}

Error codes

For a list of error codes, visit the API Error Center.