ListWorkflows-阿里云帮助中心

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

Operation description

You must purchase DataWorks Basic Edition or a higher edition to use this feature.

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

dataworks:*

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	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.
	integer	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
Tags	array	No	List of tags. A result is returned if it matches any one of the specified tags.
	string	No	Tag. Format: `key:value`. If the value is empty, the format is: `key:`	key:value

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	22C97E95-F023-56B5-8852-B1A77A17XXXX
PagingInfo	object	Pagination information.
Workflows	array<object>	The workflows.
	array<object>
Id	integer	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	integer	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	integer	The creation time.	1710239005403
ModifyTime	integer	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.
	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

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.