Retrieves a list of workflow instances.
Try it now
Test
RAM authorization
Request syntax
GET HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ClusterId |
string |
Yes |
The cluster ID. |
xxljob-b6ec1xxxx |
| AppName |
string |
No |
The application name. |
test-app |
| WorkflowId |
integer |
No |
The workflow ID. |
20 |
| WorkflowName |
string |
No |
The workflow name. |
myWorkflow |
| WorkflowExecutionId |
integer |
No |
The workflow execution ID. |
100 |
| Status |
integer |
No |
The workflow execution status. Use this parameter to filter executions by status. Valid values:
|
4 |
| StartTime |
string |
No |
The start of the time range for filtering executions. The time must be in |
2025-10-27 02:15:00 |
| EndTime |
string |
No |
The end of the time range for filtering executions. The time must be in |
2025-10-13 16:00:00 |
| PageNum |
integer |
No |
The page number. |
1 |
| PageSize |
integer |
No |
The number of entries per page. |
10 |
| MaxResults |
integer |
No |
The maximum number of results to return. Defaults to 10. |
10 |
| NextToken |
string |
No |
The token to retrieve the next page of results. For the first request, do not specify this parameter. If the response does not include a |
eCKqVlS5FKF5EWGGOo8EgQ== |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The root object of the response. |
||
| Code |
integer |
The response code. A value of |
200 |
| RequestId |
string |
The unique request ID. Use this ID to troubleshoot issues. |
BAC1ADB5-EEB5-5834-93D8-522E067AF8D9 |
| Message |
string |
The response message. If the request fails, this parameter provides details about the error. |
Parameter error: content is null. |
| Success |
boolean |
Indicates whether the request was successful. Valid values:
|
true |
| Data |
object |
|
|
| Records |
array<object> |
|
|
|
object |
|
||
| WorkflowExecutionId |
string |
The workflow execution ID. |
100 |
| WorkflowId |
string |
The workflow ID. |
10 |
| WorkflowName |
string |
The workflow name. |
myWorkflow |
| ScheduleTime |
string |
The schedule time of the workflow execution. |
2024-11-12 14:52:42 |
| DataTime |
string |
The data time of the workflow execution. |
2024-11-12 14:52:42 |
| StartTime |
string |
The start time of the workflow execution. |
2025-11-04 01:09:27 |
| EndTime |
string |
The end time of the workflow execution. |
2024-11-12 14:52:42 |
| Executor |
string |
The executor ID. |
1827811800526000 |
| Status |
integer |
The status of the workflow execution. Valid values:
|
4 |
| AppName |
string |
The application name. |
test-app |
| Total |
integer |
The total number of matching workflow executions. |
65 |
| PageNumber |
integer |
The page number. |
1 |
| PageSize |
integer |
The number of entries returned per page. |
10 |
| MaxResults |
integer |
The maximum number of entries to return per page. |
10 |
| NextToken |
string |
The token to retrieve the next page of results. If this parameter is not returned, all results have been returned. |
eCKqVlS5FKF5EWGGOo8EgQ== |
Examples
Success response
JSON format
{
"Code": 200,
"RequestId": "BAC1ADB5-EEB5-5834-93D8-522E067AF8D9",
"Message": "Parameter error: content is null.",
"Success": true,
"Data": {
"Records": [
{
"WorkflowExecutionId": "100",
"WorkflowId": "10",
"WorkflowName": "myWorkflow",
"ScheduleTime": "2024-11-12 14:52:42",
"DataTime": "2024-11-12 14:52:42",
"StartTime": "2025-11-04 01:09:27",
"EndTime": "2024-11-12 14:52:42",
"Executor": "1827811800526000",
"Status": 4,
"AppName": "test-app"
}
],
"Total": 65,
"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.