All Products
Search
Document Center

Data Management:ListTaskFlow

Last Updated:Oct 21, 2024

Queries a list of task flows.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

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
TaskFlowListarray<object>

The information about the task flows returned.

TaskFlowobject
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