ListTaskFlowsByPage - Data Management - Alibaba Cloud Documentation Center

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Tid	long	No	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***
ScenarioId	long	No	Filter condition, application scenario ID.	12***
DagIdList	array	No	Filter condition, task flow ID list.
	long	No	Filter condition, task flow ID.	45***
SearchKey	string	No	The keyword that is used to search for task flow names.	Test node
PageIndex	integer	No	The number of the page to return.	1
PageSize	integer	No	The number of entries to return on each page.	20

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	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	array<object>	The details of the returned task flows.
TaskFlow	object
Id	long	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 username of the user who created the task flow.	Creator_NickName
DagOwnerNickName	string	The username of the owner of the task flow.	Owner_NickName
DeployId	long	The ID of the last deployment record of the task flow.	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 last execution of the task flow. Valid values: 0: invalid 1: scheduling disabled 2: waiting to be scheduled	0
LatestInstanceTime	string	The time when the last execution record was created.	2022-04-13
ScenarioId	string	The ID of the application scenario.	1245
CronSwitch	boolean	Whether to enable scheduled scheduling.	false
CronStr	string	Scheduled Cron.	0 0 1 * * ? *
ScheduleParam	string	Event scheduling configuration, JSON string 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	Scheduling cycle type. Valid values: 2: Hourly scheduling 3: Daily scheduling 4: Weekly scheduling 5: Monthly scheduling	2
CronBeginDate	string	The start time of scheduled scheduling. The task flow is not scheduled before this point in time.	1970-01-01
CronEndDate	string	The end time of scheduled scheduling. The task flow is not scheduled after this point in time.	2023-01-01
TimeZoneId	string	Time zone setting. Default value: East 8(Asia/Shanghai).	Asia/Shanghai
DagOwnerId	string	The user ID of the task flow owner.	12***89
TotalCount	integer	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 time	Summary of changes	Operation
2023-06-05	The response structure of the API has changed	View Change Details
2023-05-26	The response structure of the API has changed	View Change Details
2023-05-26	The response structure of the API has changed	View Change Details
2023-05-25	The request parameters of the API has changed. The response structure of the API has changed	View Change Details