ListWorkflowDefinitions - DataWorks - Alibaba Cloud Documentation Center

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

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
ProjectId	string	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	The workflow type. This parameter specifies a filter condition. Valid values: CycleWorkflow ManualWorkflow	CycleWorkflow
Owner	string	No	The ID of the Alibaba Cloud account used by the workspace administrator. You can log on to the Alibaba Cloud Management Console and view the ID on the Security Settings page.	110755000425XXXX
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
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.
workflowDefinition	object
ProjectId	string	The ID of the DataWorks workspace to which the workflow belongs.	4710
Owner	string	The owner.	110755000425XXXX
CreateTime	long	The time when the workflow was created. This value is a UNIX timestamp.	1698057323000
ModifyTime	long	The times when the workflow was last modified. This value is a UNIX timestamp.	1698057323000
Description	string	The description of the workflow.
Type	string	The type of the workflow. Valid values: CycleWorkflow ManualWorkflow	CycleWorkflow
Script	object	The script information.
Path	string	The script path.
Runtime	object	The runtime.
Command	string	The command.	WORKFLOW
Id	string	The script ID.	698002781368644XXXX
Id	string	The ID of the workflow.	463497880880954XXXX
Name	string	The name of the workflow.

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history