All Products
Search
Document Center

Data Management:ListTasksInTaskFlow

Last Updated:Feb 27, 2024

Queries the tasks in a specified task flow.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dms:ListTasksInTaskFlowRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

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***
DagIdlongYes

The ID of the task flow. You can call the ListTaskFlow or ListLhTaskFlowAndScenario operation to query the task flow ID.

32***

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request. You can use the ID to locate logs and troubleshoot issues.

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

The error code returned if the request failed.

UnknownError
ErrorMessagestring

The error message returned if the request failed.

UnknownError
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
Tasksobject []

The tasks in the task flow.

NodeNamestring

The name of the node.

Cross-Database Spark SQL-1
NodeTypestring

The type of the node. For more information about the valid values for this parameter, see NodeType parameter.

SPARK_SQL
NodeContentstring

The configuration for the node.

{ "dbId":123***, "sql":"", "dbType":"polardb" }
TimeVariablesstring

The time variables configured for the node.

{\"variables\":[{\"name\":\"test1\",\"pattern\":\"yyyy-MM-dd
NodeConfigstring

The advanced configuration for the node.

{ "rerun":{ "rerunEnable":true, "rerunCount":1, "rerunInterval":10 // }}
NodeOutputstring

The output variables for the task.

{ "outputs":[{ { "row":0, "column":-1, "combiner":"," } "extractMethod":"{\"row\":0,\"column\":-1,\"combiner\":\",\"}", "variableName":"var", "description":"For demo"} ] }
GraphParamstring

The position of the node on the Directed Acyclic Graph (DAG).

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

The ID of the node.

92***

Examples

Sample success responses

JSONformat

{
  "RequestId": "8B36B063-6B7D-5595-9FCF-3844B7B7ACD4",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Tasks": {
    "Task": [
      {
        "NodeName": "Cross-Database Spark SQL-1",
        "NodeType": "SPARK_SQL",
        "NodeContent": "{     \"dbId\":123***,  \"sql\":\"\",    \"dbType\":\"polardb\" }",
        "TimeVariables": "{\\\"variables\\\":[{\\\"name\\\":\\\"test1\\\",\\\"pattern\\\":\\\"yyyy-MM-dd",
        "NodeConfig": "{     \"rerun\":{    \"rerunEnable\":true,      \"rerunCount\":1,   \"rerunInterval\":10 //  }}",
        "NodeOutput": "{  \"outputs\":[{ { \"row\":0, \"column\":-1,                  \"combiner\":\",\" }            \"extractMethod\":\"{\\\"row\\\":0,\\\"column\\\":-1,\\\"combiner\\\":\\\",\\\"}\",         \"variableName\":\"var\",    \"description\":\"For demo\"} ] }",
        "GraphParam": "{\\\"x\\\":435,\\\"y\\\":192,\\\"layoutType\\\":\\\"Horizontal\\\"}",
        "NodeId": "92***"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history