ListWorkflowDefinitions-阿里云帮助中心

Queries a list of workflows in DataStudio. You can also specify filter conditions to query specific workflows.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID. You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.	10000
Type	string	No	Filter condition: The type of the workflow. The default value is CycleWorkflow. Valid values: CycleWorkflow ManualWorkflow	CycleWorkflow
Owner	string	No	Filter condition: The type of the workflow. The default value is CycleWorkflow. Valid values: CycleWorkflow ManualWorkflow	110755000425XXXX
Name	string	No	The name of the workflow. Fuzzy search is supported.	test
PageNumber	integer	No	The page number of the data to retrieve, used for pagination.	1
PageSize	integer	No	The page number of the data to retrieve, used for pagination.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	8C3ED0C5-ABAB-55E1-854B-DAC02B11XXXX
PagingInfo	object	The pagination information.
TotalCount	integer	The total number of entries returned.	227
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
WorkflowDefinitions	array<object>	The workflows.
	array<object>
ProjectId	integer	The ID of the DataWorks workspace to which the workflow belongs.	4710
Owner	string	Owner	110755000425XXXX
CreateTime	integer	The timestamp when the workflow was created.	1698057323000
ModifyTime	integer	The timestamp when the workflow was last modified.	1698057323000
Description	string	Description	Workflow description
Type	string	The type of the workflow. Valid values: CycleWorkflow ManualWorkflow	CycleWorkflow
Script	object	The script information.
Path	string	The script path.	XX/OpenAPI_test/workflow_test/OpenAPI_test_workflow_Demo
Runtime	object	Runtime
Command	string	Command	WORKFLOW
Id	string	The ID of the script. Note This field is of type Long in SDK versions prior to 8.0.0, and of type String in SDK version 8.0.0 and later. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures due to the type change may occur only when upgrading the SDK across version 8.0.0, in which case users need to manually correct the data type.	698002781368644XXXX
Name	string	The name of the workflow.	OpenAPI test workflow Demo
Id	string	The unique identifier of the workflow. Note Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.	463497880880954XXXX

Examples

Success response

JSON format

{
  "RequestId": "8C3ED0C5-ABAB-55E1-854B-DAC02B11XXXX",
  "PagingInfo": {
    "TotalCount": 227,
    "PageSize": 10,
    "PageNumber": 1,
    "WorkflowDefinitions": [
      {
        "ProjectId": 4710,
        "Owner": "110755000425XXXX",
        "CreateTime": 1698057323000,
        "ModifyTime": 1698057323000,
        "Description": "Workflow description",
        "Type": "CycleWorkflow",
        "Script": {
          "Path": "XX/OpenAPI_test/workflow_test/OpenAPI_test_workflow_Demo",
          "Runtime": {
            "Command": "WORKFLOW"
          },
          "Id": "698002781368644XXXX"
        },
        "Name": "OpenAPI test workflow Demo",
        "Id": "463497880880954XXXX"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.