ListWorkflows-阿里云帮助中心

Lists your 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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the cluster.	xxljob-b6ec1xxxx
AppName	string	No	The name of the application.	test-app
Status	integer	No	The status of the workflow. If this parameter is not specified, workflows in the `disabled` state are returned by default. Valid values: `0`: disabled `1`: enabled	1
WorkflowId	integer	No	The ID of the workflow.	20
Name	string	No	The name of the workflow.	myWorkflow
Description	string	No	The description of the workflow.	my first workflow
PageNum	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	50
MaxResults	integer	No	The maximum number of entries to return. The default value is 10.	10
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. If the return value is empty, no more data is returned.	eCKqVlS5FKF5EWGGOo8EgQ==

Response elements

Element	Type	Description	Example
	object	The response object.
Code	integer	The response code.	200
Message	string	The error message.	Parameter error: content is null.
RequestId	string	The unique request ID that is generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.	39938688-0BAB-5AD8-BF02-F4910FAC7589
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Data	object	The returned data.
Records	array<object>	The list of workflows.
	object	The basic information about the workflow.
WorkflowId	integer	The workflow ID.	10
Name	string	The workflow name.	myWorkflow
Description	string	The workflow description.	my first workflow
Status	integer	The status of the workflow. Valid values: `0`: disabled `1`: enabled	1
MaxConcurrency	integer	The maximum number of concurrent instances.	100
TimeType	integer	The scheduling type. The following types are supported: `-1`: none `1`: cron `100`: api	1
TimeExpression	string	The time expression.	0 0 12 * * ?
Timezone	string	The time zone.	HangKong
Calendar	string	The calendar.	work-day
Creator	string	The user who created the workflow.	1963096506470832
Updater	string	The user who last updated the workflow.	1963096506470832
Xattrs	string	The extended attributes. Note This parameter is not supported.	暂无
AppName	string	The application name.	test-app
LastExecuteEndTime	string	The time when the last execution ended.	2025-06-29 15:56:36
LastExecuteStatus	integer	The result of the last execution. Valid values: `4`: success `5`: failed	4
CurrentExecuteStatus	integer	The current execution status. Valid values: `0`: not started `1`: running `2`: in queue `3`: waiting	3
AppType	integer	The application type.	1
Total	integer	The total number of entries.	64
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
MaxResults	integer	The maximum number of entries to return. Default value: 10.	10
NextToken	string	If the query does not return all results, this token is returned. You can use this token to retrieve the next page of results. You do not need to specify this parameter for the first request.	eCKqVlS5FKF5EWGGOo8EgQ==

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "Parameter error: content is null.",
  "RequestId": "39938688-0BAB-5AD8-BF02-F4910FAC7589",
  "Success": true,
  "Data": {
    "Records": [
      {
        "WorkflowId": 10,
        "Name": "myWorkflow",
        "Description": "my first workflow",
        "Status": 1,
        "MaxConcurrency": 100,
        "TimeType": 1,
        "TimeExpression": "0 0 12 * * ?",
        "Timezone": "HangKong",
        "Calendar": "work-day",
        "Creator": "1963096506470832",
        "Updater": "1963096506470832",
        "Xattrs": "暂无",
        "AppName": "test-app",
        "LastExecuteEndTime": "2025-06-29 15:56:36\n",
        "LastExecuteStatus": 4,
        "CurrentExecuteStatus": 3,
        "AppType": 1
      }
    ],
    "Total": 64,
    "PageNumber": 1,
    "PageSize": 10,
    "MaxResults": 10,
    "NextToken": "eCKqVlS5FKF5EWGGOo8EgQ=="
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	Parameter error: %s.	Parameter error: %s
401	IllegalRequest	IllegalRequest: %s.	Illegal request:%s
500	InternalError	InternalError: %s.	System Internal Error: %s
403	NoPermission	No permission to perform this operation: %s.	No permission to perform this operation: %s
404	NotFound	Not found: %s.	The resource does not exist: %s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.