All Products
Search
Document Center

Data Management:ListTaskFlow

Last Updated:Feb 22, 2024

Queries task flows.

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:ListTaskFlowRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to obtain the tenant ID.

3***

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

4116147E-C628-5816-8779-8EEAF8E973F4
ErrorCodestring

The error code.

403
ErrorMessagestring

The error message.

UnknownError
Successboolean

Indicates whether the request was successful. Valid values:

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

The information about the task flows returned.

Idlong

The ID of the task flow.

134137****
CreatorIdstring

The ID of the user who creates the task flow.

51****
CreatorNickNamestring

The name of the user who creates the task flow.

Creator_NickName
DagOwnerNickNamestring

The name of the task flow owner.

Owner_NickName
DeployIdlong

The ID of the latest deployment record.

12**
Statusinteger

The status of the task flow. Valid values:

  • 0: The task flow is invalid.
  • 1: Scheduling is disabled for the task flow.
  • 2: The task flow is waiting to be scheduled.
2
LatestInstanceStatusinteger

The status of the latest execution. Valid values:

  • 0: invalid.
  • 1: scheduling disabled.
  • 2: waiting to be scheduled.
0
LatestInstanceTimestring

The time when the latest execution record was generated.

2022-04-13

Examples

Sample success responses

JSONformat

{
  "RequestId": "4116147E-C628-5816-8779-8EEAF8E973F4",
  "ErrorCode": "403",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "TaskFlowList": {
    "TaskFlow": [
      {
        "Id": 0,
        "CreatorId": "51****",
        "CreatorNickName": "Creator_NickName",
        "DagOwnerNickName": "Owner_NickName",
        "DeployId": 0,
        "Status": 2,
        "LatestInstanceStatus": 0,
        "LatestInstanceTime": "2022-04-13"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history