ListWorkflows - DataWorks - Alibaba Cloud Documentation Center

Queries a list of workflows by page. You can also specify filter conditions to query workflows.

Operation description

This API operation is available for all DataWorks editions.

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

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
dataworks:*	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	long	Yes	The workspace ID.	100
EnvType	string	No	The environment of the workspace. Valid values: Prod: production environment Dev: development environment	Prod
Ids	array	No	The IDs of the workflows. You can query multiple workflows at a time by workflow ID.
Id	long	No	The workflow ID.	1234
Name	string	No	The name of the workflow. Fuzzy match is supported.	Workflow1
Owner	string	No	The account ID of the workflow owner.	1000
TriggerType	string	No	The trigger type. Scheduler Manual TriggerWorkflow	Scheduler
SortBy	string	No	The field used for sorting. Fields such as TriggerTime and StartedTime are supported. The value of this parameter is in the Sort field + Sort by (Desc/Asc) format. By default, results are sorted in ascending order. Valid values: ModifyTime (Desc/Asc) CreateTime (Desc/Asc) Id (Desc/Asc) Default value: Id Desc.	Id Desc
PageSize	integer	No	The number of entries per page. Default value: 10.	10
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	22C97E95-F023-56B5-8852-B1A77A17XXXX
PagingInfo	object	Pagination information.
Workflows	array<object>	The workflows.
Workflow	object
Id	long	The workflow ID.	1234
Name	string	The name.	Workflow1
Description	string	The description.	test
Trigger	object	The trigger method.
Type	string	The trigger type. Valid values: Scheduler: scheduling cycle-based trigger Manual: manual trigger	Scheduler
Recurrence	string	The running mode of the workflow after it is triggered. This parameter takes effect only if the Type parameter is set to Scheduler. Valid values: Pause Skip Normal	Normal
Cron	string	The CRON expression. This parameter takes effect only if the Type parameter is set to Scheduler.	00 00 00 * * ?
StartTime	string	The start time of the time range during which the workflow is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.	1970-01-01 00:00:00
EndTime	string	The end time of the time range during which the workflow is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.	9999-01-01 00:00:00
Parameters	string	The parameters.	para1=$bizdate para2=$[yyyymmdd]
ClientUniqueCode	string	The unique code of the client. This parameter is used to create a workflow asynchronously and implement the idempotence of the workflow. If you do not specify this parameter when you create the workflow, the system automatically generates a unique code. The unique code is uniquely associated with the workflow ID. If you specify this parameter when you update or delete the workflow, the value of this parameter must be the unique code that is used to create the workflow.	Workflow_0bc5213917368545132902xxxxxxxx
ProjectId	long	The workspace ID.	100
EnvType	string	The environment of the workspace. Valid values: Prod Dev	Prod
Owner	string	The account ID of the owner.	1000
CreateTime	long	The creation time.	1710239005403
ModifyTime	long	The modification time.	1710239005403
CreateUser	string	The account ID of the creator.	1000
ModifyUser	string	The account ID of the modifier.	1000
Tags	array<object>	The task tag.
Tag	object
Key	string	The key of a tag.	key1
Value	string	The value of a tag.	value1
TotalCount	integer	The total number of entries returned.	100
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "PagingInfo": {
    "Workflows": [
      {
        "Id": 1234,
        "Name": "Workflow1",
        "Description": "test",
        "Trigger": {
          "Type": "Scheduler",
          "Recurrence": "Normal",
          "Cron": "00 00 00 * * ?",
          "StartTime": "1970-01-01 00:00:00",
          "EndTime": "9999-01-01 00:00:00"
        },
        "Parameters": "para1=$bizdate para2=$[yyyymmdd] ",
        "ClientUniqueCode": "Workflow_0bc5213917368545132902xxxxxxxx",
        "ProjectId": 100,
        "EnvType": "Prod",
        "Owner": 1000,
        "CreateTime": 1710239005403,
        "ModifyTime": 1710239005403,
        "CreateUser": 1000,
        "ModifyUser": 1000,
        "Tags": [
          {
            "Key": "key1",
            "Value": "value1"
          }
        ]
      }
    ],
    "TotalCount": 100,
    "PageSize": 10,
    "PageNumber": 1
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2025-11-25	The request parameters of the API has changed	View Change Details