调用ListTasksInTaskFlow接口,获取指定任务流的任务节点列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListTasksInTaskFlow |
系统规定参数。取值:ListTasksInTaskFlow。 |
| Tid | Long | 否 | 3*** |
租户ID。 说明 鼠标移动到界面右上角的头像处,查看租户ID。具体操作,请参见查看租户信息。
|
| DagId | Long | 是 | 32*** |
任务流ID,可通过调用接口ListTaskFlow或ListLhTaskFlowAndScenario获取该参数的值。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | 8B36B063-6B7D-5595-9FCF-3844B7B7ACD4 |
请求ID,用于定位日志,排查问题。 |
| ErrorCode | String | UnknownError |
错误码。 |
| ErrorMessage | String | 任务流不存在或没有权限 |
调用失败时,返回的错误信息。 |
| Success | Boolean | true |
请求是否成功,返回值如下:
|
| Tasks | Array of Task |
任务列表。 |
|
| Task | |||
| NodeName | String | Cross-Database Spark SQL-1 |
节点名称。 |
| NodeType | String | SPARK_SQL |
任务节点类型,返回值请参见NodeType参数说明。 |
| NodeContent | String | { "dbId":123456, // 数据库Id "sql":"/* 请使用当前节点所选择的数据库语法编写SQL */", // sql语句 "dbType":"polardb" // 数据库类型 } |
节点配置内容。 |
| TimeVariables | String | { "variables":[ // "variables"为固定值 { "name":"var", // name指定变量名 "pattern":"yyyy-MM-dd|+0m+0h-2d+0w+0M+1y" // 见后面解释 } ] } |
节点变量(时间变量配置)。 |
| NodeConfig | String | { "rerun":{ // 必填固定值 "rerunEnable":true, // 是否开启重跑 "rerunCount":1, // 重跑次数 "rerunInterval":10 // 重跑间隔 } } |
节点高级配置。 |
| NodeOutput | String | { "outputs":[ { /* 变量提取设置 { "row":0, // 行,-1为所有行 "column":-1, // 列,-1为所有列 /* 分隔符 当选中所有行或所有列时,需要指定连接符。变量返回值为字符串 */ "combiner":"," } */ "extractMethod":"{\"row\":0,\"column\":-1,\"combiner\":\",\"}", "variableName":"var", // 变量名 "description":"For demo" // 变量介绍 } ] } |
任务输出变量。 |
| GraphParam | String | {\"x\":435,\"y\":192,\"layoutType\":\"Horizontal\"} |
节点在图上的显示位置。 |
| NodeId | String | 92*** |
节点ID。 |
示例
请求示例
http(s)://dms-enterprise.aliyuncs.com/?Action=ListTasksInTaskFlow
&Tid=3***
&DagId=32***
&公共请求参数
正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListTasksInTaskFlowResponse>
<RequestId>8B36B063-6B7D-5595-9FCF-3844B7B7ACD4</RequestId>
<Success>true</Success>
<Tasks>
<NodeName>Cross-Database Spark SQL-1</NodeName>
<NodeType>SPARK_SQL</NodeType>
<NodeContent>{ "dbId":123456, // 数据库Id "sql":"/* 请使用当前节点所选择的数据库语法编写SQL */", // sql语句 "dbType":"polardb" // 数据库类型 }</NodeContent>
<TimeVariables>{ "variables":[ // "variables"为固定值 { "name":"var", // name指定变量名 "pattern":"yyyy-MM-dd|+0m+0h-2d+0w+0M+1y" // 见后面解释 } ] }</TimeVariables>
<NodeConfig>{ "rerun":{ // 必填固定值 "rerunEnable":true, // 是否开启重跑 "rerunCount":1, // 重跑次数 "rerunInterval":10 // 重跑间隔 } }</NodeConfig>
<NodeOutput>{ "outputs":[ { /* 变量提取设置 { "row":0, // 行,-1为所有行 "column":-1, // 列,-1为所有列 /* 分隔符 当选中所有行或所有列时,需要指定连接符。变量返回值为字符串 */ "combiner":"," } */ "extractMethod":"{\"row\":0,\"column\":-1,\"combiner\":\",\"}", "variableName":"var", // 变量名 "description":"For demo" // 变量介绍 } ] }</NodeOutput>
<GraphParam>{\"x\":435,\"y\":192,\"layoutType\":\"Horizontal\"}</GraphParam>
<NodeId>92***</NodeId>
</Tasks>
</ListTasksInTaskFlowResponse>
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "8B36B063-6B7D-5595-9FCF-3844B7B7ACD4",
"Success" : true,
"Tasks" : [ {
"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***"
} ]
}
错误码
访问错误中心查看更多错误码。