文档

ListTasksInTaskFlow - 获取指定任务流的任务节点列表

调用ListTasksInTaskFlow接口,获取指定任务流的任务节点列表。

调试

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

授权信息

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

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

请求参数

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

租户 ID。

说明 鼠标移动到界面右上角的头像处,查看租户 ID。具体操作,请参见查看租户信息
3***
DagIdlong

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

32***

返回参数

名称类型描述示例值
object

返回参数详情如下。

RequestIdstring

请求 ID,用于定位日志,排查问题。

8B36B063-6B7D-5595-9FCF-3844B7B7ACD4
ErrorCodestring

错误码。

UnknownError
ErrorMessagestring

调用失败时,返回的错误信息。

任务流不存在或没有权限
Successboolean

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

  • true:请求成功
  • false:请求失败
true
Tasksobject []

任务列表。

NodeNamestring

节点名称。

Cross-Database Spark SQL-1
NodeTypestring

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

SPARK_SQL
NodeContentstring

节点配置内容。

{ "dbId":123456, // 数据库Id "sql":"/* 请使用当前节点所选择的数据库语法编写SQL */", // sql语句 "dbType":"polardb" // 数据库类型 }
TimeVariablesstring

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

{ "variables":[ // "variables"为固定值 { "name":"var", // name指定变量名 "pattern":"yyyy-MM-dd|+0m+0h-2d+0w+0M+1y" // 见后面解释 } ] }
NodeConfigstring

节点高级配置。

{ "rerun":{ // 必填固定值 "rerunEnable":true, // 是否开启重跑 "rerunCount":1, // 重跑次数 "rerunInterval":10 // 重跑间隔 } }
NodeOutputstring

任务输出变量。

{ "outputs":[ { /* 变量提取设置 { "row":0, // 行,-1为所有行 "column":-1, // 列,-1为所有列 /* 分隔符 当选中所有行或所有列时,需要指定连接符。变量返回值为字符串 */ "combiner":"," } */ "extractMethod":"{\"row\":0,\"column\":-1,\"combiner\":\",\"}", "variableName":"var", // 变量名 "description":"For demo" // 变量介绍 } ] }
GraphParamstring

节点在图上的显示位置。

{\"x\":435,\"y\":192,\"layoutType\":\"Horizontal\"}
NodeIdstring

节点 ID。

92***

示例

正常返回示例

JSON格式

{
  "RequestId": "8B36B063-6B7D-5595-9FCF-3844B7B7ACD4",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "任务流不存在或没有权限",
  "Success": true,
  "Tasks": {
    "Task": [
      {
        "NodeName": "Cross-Database Spark SQL-1",
        "NodeType": "SPARK_SQL",
        "NodeContent": "{     \"dbId\":123456, // 数据库Id     \"sql\":\"/* 请使用当前节点所选择的数据库语法编写SQL */\", // sql语句     \"dbType\":\"polardb\" // 数据库类型 }",
        "TimeVariables": "{   \"variables\":[     // \"variables\"为固定值     {       \"name\":\"var\", // name指定变量名       \"pattern\":\"yyyy-MM-dd|+0m+0h-2d+0w+0M+1y\" // 见后面解释     }   ] }",
        "NodeConfig": "{     \"rerun\":{ // 必填固定值         \"rerunEnable\":true, // 是否开启重跑         \"rerunCount\":1, // 重跑次数         \"rerunInterval\":10 // 重跑间隔     } }",
        "NodeOutput": "{     \"outputs\":[         {             /*             变量提取设置             {                 \"row\":0, // 行,-1为所有行                 \"column\":-1, // 列,-1为所有列                 /*                 分隔符                 当选中所有行或所有列时,需要指定连接符。变量返回值为字符串                 */                 \"combiner\":\",\"              }             */             \"extractMethod\":\"{\\\"row\\\":0,\\\"column\\\":-1,\\\"combiner\\\":\\\",\\\"}\",              \"variableName\":\"var\", // 变量名             \"description\":\"For demo\" // 变量介绍         }     ] }",
        "GraphParam": "{\\\"x\\\":435,\\\"y\\\":192,\\\"layoutType\\\":\\\"Horizontal\\\"}",
        "NodeId": "92***"
      }
    ]
  }
}

错误码

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

变更历史

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