List DMS Task Flow Tasks via ListTasksInTaskFlow - Data Management - Alibaba Cloud - Data Management

Queries the tasks in a specified task flow.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:ListTasksInTaskFlow

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tid	integer	No	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.	3***
DagId	integer	Yes	The ID of the task flow. You can call the ListTaskFlow or ListLhTaskFlowAndScenario operation to query the task flow ID.	32***

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request. You can use the ID to locate logs and troubleshoot issues.	8B36B063-6B7D-5595-9FCF-3844B7B7ACD4
ErrorCode	string	The error code returned if the request failed.	UnknownError
ErrorMessage	string	The error message returned if the request failed.	The task flow does not exist, or you do not have the required permissions.
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Tasks	object
Task	array<object>	The tasks in the task flow.
	object	The details of the task.
NodeName	string	The name of the node.	Cross-Database Spark SQL-1
NodeType	string	The type of the node. For more information about the valid values for this parameter, see NodeType parameter.	SPARK_SQL
NodeContent	string	The configuration for the node.	{ "dbId":123456, // Database ID "sql":"/* Write SQL statements in the syntax of the database selected for the current node */", // SQL statement "dbType":"polardb" // Database type }
TimeVariables	string	The time variables configured for the node.	{ "variables":[ // Fixed key name "variables" { "name":"var", // Variable name "pattern":"yyyy-MM-dd\|+0m+0h-2d+0w+0M+1y" // See the following description } ] }
NodeConfig	string	The advanced configuration for the node.	{ "rerun":{ // Required fixed key "rerunEnable":true, // Specifies whether to enable rerun "rerunCount":1, // Number of reruns "rerunInterval":10 // Interval between reruns } }
NodeOutput	string	The output variables for the task.	{ "outputs":[ { /* Variable extraction settings { "row":0, // Row. -1 indicates all rows "column":-1, // Column. -1 indicates all columns /* Delimiter. When all rows or all columns are selected, specify a connector. The variable return value is a string / "combiner":"," } / "extractMethod":"{\"row\":0,\"column\":-1,\"combiner\":\",\"}", "variableName":"var", // Variable name "description":"For demo" // Variable description } ] }
GraphParam	string	The position of the node on the Directed Acyclic Graph (DAG).	{\"x\":435,\"y\":192,\"layoutType\":\"Horizontal\"}
NodeId	string	The ID of the node.	92***

Examples

Success response

JSON format

{
  "RequestId": "8B36B063-6B7D-5595-9FCF-3844B7B7ACD4",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "The task flow does not exist, or you do not have the required permissions.",
  "Success": true,
  "Tasks": {
    "Task": [
      {
        "NodeName": "Cross-Database Spark SQL-1",
        "NodeType": "SPARK_SQL",
        "NodeContent": "{     \"dbId\":123456, // Database ID     \"sql\":\"/* Write SQL statements in the syntax of the database selected for the current node */\", // SQL statement     \"dbType\":\"polardb\" // Database type }",
        "TimeVariables": "{   \"variables\":[     // Fixed key name \"variables\"     {       \"name\":\"var\", // Variable name       \"pattern\":\"yyyy-MM-dd|+0m+0h-2d+0w+0M+1y\" // See the following description     }   ] }",
        "NodeConfig": "{     \"rerun\":{ // Required fixed key         \"rerunEnable\":true, // Specifies whether to enable rerun         \"rerunCount\":1, // Number of reruns         \"rerunInterval\":10 // Interval between reruns     } }",
        "NodeOutput": "{     \"outputs\":[         {             /*             Variable extraction settings             {                 \"row\":0, // Row. -1 indicates all rows                 \"column\":-1, // Column. -1 indicates all columns                 /*                 Delimiter                 When all rows or all columns are selected, specify a connector. The variable return value is a string                 */                 \"combiner\":\",\"              }             */             \"extractMethod\":\"{\\\"row\\\":0,\\\"column\\\":-1,\\\"combiner\\\":\\\",\\\"}\",              \"variableName\":\"var\", // Variable name             \"description\":\"For demo\" // Variable description         }     ] }",
        "GraphParam": "{\\\"x\\\":435,\\\"y\\\":192,\\\"layoutType\\\":\\\"Horizontal\\\"}",
        "NodeId": "92***"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.