ListTaskFlowsByPage - Query task flows by page - Data Management

Queries task flow details with pagination.

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:ListTaskFlowsByPage

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tid	integer	No	The ID of the tenant. Note To find the tenant ID, hover over the profile picture in the upper-right corner of the DMS console. View information about the current tenant.	3***
ScenarioId	integer	No	The ID of the application scenario to filter by.	12***
DagIdList	array	No	The IDs of the task flows to filter by.
	integer	No	The ID of a task flow to filter by.	4512
SearchKey	string	No	The keyword used to search for task flow names.	测试节点
PageIndex	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	20

Filter conditions are evaluated with the AND operator.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	6CB28697-BFE2-5739-9228-3971990E982C
ErrorCode	string	The error code returned if the request failed.	UnknownError
ErrorMessage	string	The error message returned if the request failed.	UnknownError
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
TaskFlowList	object
TaskFlow	array<object>	The task flow details.
	object
Id	integer	The ID of the task flow.	7***
DagName	string	The name of the task flow.	poc_task_test
Description	string	The description of the task flow.	test
CreatorId	string	The ID of the user who created the task flow.	51****
CreatorNickName	string	The nickname of the task flow creator.	Creator_NickName
DagOwnerNickName	string	The nickname of the task flow owner.	Owner_NickName
DeployId	integer	The ID of the latest deployment record.	65***
Status	integer	The status of the task flow. Valid values: 0: invalid 1: scheduling disabled 2: waiting to be scheduled	1
LatestInstanceStatus	integer	The status of the latest execution. Valid values: 0: invalid 1: scheduling disabled 2: waiting to be scheduled	0
LatestInstanceTime	string	The creation time of the latest execution record.	2022-04-13
ScenarioId	string	The ID of the application scenario.	1245
CronSwitch	boolean	Indicates whether scheduled triggering is enabled.	false
CronStr	string	The cron expression for scheduled triggering.	0 0 1 * * ? *
ScheduleParam	string	The event-triggered scheduling configuration in JSON format.	{\"triggerType\":\"1\",\"specificTime\":'2022-11-15 11:59'}
TriggerType	integer	The trigger type. Valid values: 0: Periodic scheduling 1: Run manually	0
CronType	integer	The scheduling cycle type. Valid values: 2: Hourly scheduling 3: Daily scheduling 4: Weekly scheduling 5: Monthly scheduling	2
CronBeginDate	string	The start time of the scheduling period. The task flow is not triggered before this time.	1970-01-01
CronEndDate	string	The end time of the scheduling period. The task flow is not triggered after this time.	2023-01-01
TimeZoneId	string	The time zone. Default value: Asia/Shanghai (UTC+8).	Asia/Shanghai
DagOwnerId	string	The user ID of the task flow owner.	12***89
TotalCount	integer	The total number of entries.	24

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.