ListTasksInTaskFlow -

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 for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	ListTasksInTaskFlow	The operation that you want to perform. Set the value to ListTasksInTaskFlow.
Tid	Long	No	3***	The ID of the tenant. Note To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see View information about the current tenant.
DagId	Long	Yes	32***	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	8B36B063-6B7D-5595-9FCF-3844B7B7ACD4	The ID of the request. You can use the ID to locate logs and troubleshoot issues.
ErrorCode	String	UnknownError	The error code returned if the request failed.
ErrorMessage	String	The task flow does not exist, or you don't have the permission.	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.
Tasks	Array of Task		The tasks in the task flow.
Task
NodeName	String	Cross-Database Spark SQL-1	The name of the node.
NodeType	String	SPARK_SQL	The type of the node. For more information about the valid values for this parameter, see NodeType parameter.
NodeContent	String	{ "dbId":123456, // Database ID "sql":"/* Use the database syntax selected for the current node to write SQL statements */", // SQL statement "dbType":"polardb" // Database type }	The configuration for the node.
TimeVariables	String	{ "variables":[ // "variables" are fixed values { "name":"var", // "name" indicates the variable name "pattern":"yyyy-MM-dd\|+0m+0h-2d+0w+0M+1y" // See later comments } ] }	The time variables configured for the node.
NodeConfig	String	{ "rerun":{ // Fixed value (Required) "rerunEnable":true, // Whether to enable rerun "rerunCount":1, // Number of reruns "rerunInterval":10 // Rerun interval } }	The advanced configuration for the node.
NodeOutput	String	{ "outputs":[ { /* Variable extraction settings { "row":0, // Rows. -1 indicates all rows. "column":-1, // Columns. -1 indicates all columns. /* Delimiter When you select all rows or columns, you must specify a connector. The returned value of the variable is a string. / "combiner":"," } / "extractMethod":"{\"row\":0,\"column\":-1,\"combiner\":\",\"}", "variableName":"var", // Variable name "description":"For demo" // Variable description } ] }	The output variables for the task.
GraphParam	String	{\"x\":435,\"y\":192,\"layoutType\":\"Horizontal\"}	The position of the node on the Directed Acyclic Graph (DAG).
NodeId	String	92***	The ID of the node.

Examples

Sample requests

 
 
 
&Common request parameters

Sample success responses

XML format

 
 

 
     
     
     
         
         
        <NodeContent>{     "dbId":123456, // Database ID     "sql":"/* Use the database syntax selected for the current node to write SQL statements. */", // SQL statement     "dbType":"polardb" // Database type }</NodeContent>
        <TimeVariables>{   "variables":[     // "variables" are fixed values.     {       "name":"var", // "name" indicates the variable name       "pattern":"yyyy-MM-dd|+0m+0h-2d+0w+0M+1y" // See later comments     }   ] }</TimeVariables>
        <NodeConfig>{     "rerun":{ // Fixed value (Required)         "rerunEnable":true, // Whether to enable rerun         "rerunCount":1, // Number of reruns         "rerunInterval":10 // Rerun interval     } }</NodeConfig>
        <NodeOutput>{     "outputs":[         {             /*             Variable extraction settings             {                 "row":0, // Rows. -1 indicates all rows.                 "column":-1, // Columns. -1 indicates all columns.                /*                 Delimiter                 If you select all rows or columns, you must specify a connector. The returned value of the variable is a string.                 */                 "combiner":","              }             */             "extractMethod":"{\"row\":0,\"column\":-1,\"combiner\":\",\"}",              "variableName":"var", // Variable name             "description":"For demo" // Variable description         }     ] }</NodeOutput>

JSON format

 
 

 
   
   
   
     
     
    "NodeContent" : "{     \"dbId\":123456, // Database ID     \"sql\":\"/* Use the database syntax selected for the current node to write SQL statements */\", // SQL statement     \"dbType\":\"polardb\" // Database type }",
    "TimeVariables" : "{   \"variables\":[     // \"variables\" are fixed values     {       \"name\":\"var\", // "name" indicates the variable name       \"pattern\":\"yyyy-MM-dd|+0m+0h-2d+0w+0M+1y\" // See later comments     }   ] }",
    "NodeConfig" : "{     \"rerun\":{ // Fixed value (required)         \"rerunEnable\":true, // Whether to enable rerun         \"rerunCount\":1, // Number of reruns         \"rerunInterval\":10 // Rerun interval     } }",
    "NodeOutput" : "{     \"outputs\":[         {             /*             Variable extraction settings             {                 \"row\":0, // Rows. -1 indicates all rows.                 \"column\":-1, // Columns. -1 indicates all columns.                 /*                 Delimiter                 When you select all row or columns, you must specify a connector. The returned value of the variable is a string.                 */                 \"combiner\":\",\"              }             */             \"extractMethod\":\"{\\\"row\\\":0,\\\"column\\\":-1,\\\"combiner\\\":\\\",\\\"}\",              \"variableName\":\"var\", // Variable name             \"description\":\"For demo\" // Variable description         }     ] }",

Error codes

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