文档

GetTaskFlowGraph - 获取任务流的DAG图

更新时间:

调用GetTaskFlowGraph接口获取任务流的DAG图。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dms:GetTaskFlowGraphRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Tidlong

租户 ID。

说明 取自系统右上角头像处悬停展示的租户 ID 信息,详情请参见查看租户信息
3***
DagIdlong

任务流 ID,可通过调用接口 ListTaskFlowListLhTaskFlowAndScenario 获取该参数的值。

15***

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

错误码。

UnknownError
ErrorMessagestring

错误信息。

UnknownError
Successboolean

请求是否成功,返回值如下:

  • true:请求成功
  • false:请求失败
true
TaskFlowGraphobject

任务流的 DAG 图变量列表。

DagNamestring

任务流名称。

test
Nodesobject []

任务流节点列表。

DagIdlong

任务流 ID。

15***
NodeIdlong

任务节点 ID。

44***
NodeNamestring

任务节点名称。

test
NodeTypelong

任务节点类型,返回值请参见 NodeType 参数说明

36
NodeContentstring

节点配置内容。

{ODI3OTNRVC****UHVFT29"}
TimeVariablesstring

节点变量(时间变量配置)。

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

节点高级配置。

{\"dbId\":39****,\"dbType\":\"mysql\",\"locale\":\"zh\",\"sql\":\"/* 请确认以下SQL符合您的变更需求,务必确认无误后再提交执行 */\\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

节点在图上的显示位置。

{\"x\":541,\"y\":322,\"layoutType\":\"Horizontal\"}
Edgesobject []

任务流边列表。

DagIdlong

任务流 ID。

15***
Idlong

任务流边 ID。

24***
NodeEndlong

边的终点节点 ID。

44***
NodeFromlong

边的起点节点 ID。

44***
Statuslong

任务流状态,返回值如下:

  • 0:无效
  • 1:无调度配置
  • 2:等待调度
2
CanEditboolean

任务流是否支持编辑,返回值如下:

  • true:支持修改
  • false:不支持修改
true

示例

正常返回示例

JSON格式

{
  "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\\\":\\\"/* 请确认以下SQL符合您的变更需求,务必确认无误后再提交执行 */\\\\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
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈