All Products
Search
Document Center

Data Management:ListTaskFlowsByPage

Last Updated:Nov 28, 2024

Queries the details of task flows by page.

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

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

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

The ID of the tenant.

Note : To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see View information about the current tenant.
3***
ScenarioIdlongNo

Filter condition, application scenario ID.

12***
DagIdListarrayNo

Filter condition, task flow ID list.

longNo

Filter condition, task flow ID.

45***
SearchKeystringNo

The keyword that is used to search for task flow names.

Test node
PageIndexintegerNo

The number of the page to return.

1
PageSizeintegerNo

The number of entries to return on each page.

20

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

6CB28697-BFE2-5739-9228-3971990E982C
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
TaskFlowListarray<object>

The details of the returned task flows.

TaskFlowobject
Idlong

The ID of the task flow.

7***
DagNamestring

The name of the task flow.

poc_task_test
Descriptionstring

The description of the task flow.

test
CreatorIdstring

The ID of the user who created the task flow.

51****
CreatorNickNamestring

The username of the user who created the task flow.

Creator_NickName
DagOwnerNickNamestring

The username of the owner of the task flow.

Owner_NickName
DeployIdlong

The ID of the last deployment record of the task flow.

65***
Statusinteger

The status of the task flow. Valid values:

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

The status of the last execution of the task flow. Valid values:

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

The time when the last execution record was created.

2022-04-13
ScenarioIdstring

The ID of the application scenario.

1245
CronSwitchboolean

Whether to enable scheduled scheduling.

false
CronStrstring

Scheduled Cron.

0 0 1 * * ? *
ScheduleParamstring

Event scheduling configuration, JSON string format.

{\"triggerType\":\"1\",\"specificTime\":'2022-11-15 11:59'}
TriggerTypeinteger

The trigger type. Valid values:

  • 0: Periodic scheduling
  • 1: Run manually
0
CronTypeinteger

Scheduling cycle type. Valid values:

  • 2: Hourly scheduling
  • 3: Daily scheduling
  • 4: Weekly scheduling
  • 5: Monthly scheduling
2
CronBeginDatestring

The start time of scheduled scheduling. The task flow is not scheduled before this point in time.

1970-01-01
CronEndDatestring

The end time of scheduled scheduling. The task flow is not scheduled after this point in time.

2023-01-01
TimeZoneIdstring

Time zone setting. Default value: East 8(Asia/Shanghai).

Asia/Shanghai
DagOwnerIdstring

The user ID of the task flow owner.

12***89
TotalCountinteger

The total number of entries returned.

24

Examples

Sample success responses

JSONformat

{
  "RequestId": "6CB28697-BFE2-5739-9228-3971990E982C",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "TaskFlowList": {
    "TaskFlow": [
      {
        "Id": 0,
        "DagName": "poc_task_test",
        "Description": "test",
        "CreatorId": "51****",
        "CreatorNickName": "Creator_NickName",
        "DagOwnerNickName": "Owner_NickName",
        "DeployId": 0,
        "Status": 1,
        "LatestInstanceStatus": 0,
        "LatestInstanceTime": "2022-04-13",
        "ScenarioId": "1245",
        "CronSwitch": false,
        "CronStr": "0 0 1 * * ? *",
        "ScheduleParam": "{\\\"triggerType\\\":\\\"1\\\",\\\"specificTime\\\":'2022-11-15 11:59'}",
        "TriggerType": 0,
        "CronType": 2,
        "CronBeginDate": "1970-01-01",
        "CronEndDate": "2023-01-01",
        "TimeZoneId": "Asia/Shanghai",
        "DagOwnerId": "12***89"
      }
    ]
  },
  "TotalCount": 24
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-06-05The response structure of the API has changedView Change Details
2023-05-26The response structure of the API has changedView Change Details
2023-05-26The response structure of the API has changedView Change Details
2023-05-25The request parameters of the API has changed. The response structure of the API has changedView Change Details