All Products
Search
Document Center

Data Management:GetTaskFlowGraph

Last Updated:Oct 21, 2024

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

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***
DagIdlongYes

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

15***

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

D9D91166-A626-5F4E-9CA6-7AB10C59DBD8
ErrorCodestring

The error code returned if the request failed.

UnknownError
ErrorMessagestring

The error message returned if the request failed.

UnknownError
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
TaskFlowGraphobject

The list of DAG variables of the task flow.

DagNamestring

The name of the task flow.

test
Nodesarray<object>

The node list of the task flow.

Nodeobject
DagIdlong

The ID of the task flow.

15***
NodeIdlong

The ID of the node.

44***
NodeNamestring

The name of the node.

test
NodeTypelong

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

36
NodeContentstring

The configuration of the node.

{ODI3OTNRVC****UHVFT29"}
TimeVariablesstring

The time variables for the node.

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

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;\"}
GraphParamstring

The position of the node in the DAG.

{\"x\":541,\"y\":322,\"layoutType\":\"Horizontal\"}
Edgesarray<object>

The list of task flow edges.

Edgeobject
DagIdlong

The ID of the task flow.

15***
Idlong

The ID of the task flow edge.

24***
NodeEndlong

The ID of the end node on the edge.

44***
NodeFromlong

The ID of the start node on the edge.

44***
Statuslong

The status of the task flow. Valid values:

  • 0: invalid
  • 1: not scheduled
  • 2: to be scheduled
2
CanEditboolean

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 timeSummary of changesOperation
No change history