Queries the list of agent scheduled tasks.
Try it now
Test
RAM authorization
Request syntax
GET HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ScheduledIds |
array |
No |
Filters by scheduled task IDs. |
["scheduled-abcd1234"] |
|
string |
No |
The scheduled task ID. |
sch-260705-agb***** |
|
| Status |
string |
No |
Filters by status: ACTIVE/DISABLED. |
ACTIVE |
| TaskName |
string |
No |
The task name. |
DataSync |
| InstanceIds |
array |
No |
The list of instance IDs. |
|
|
string |
No |
The instance ID. |
acp-2kkkhb8w472e***** |
|
| PageNumber |
integer |
No |
The page number. Default value: 1. |
1 |
| PageSize |
integer |
No |
The number of entries per page. Default value: 20. Maximum value: 100. |
20 |
| MaxResults |
integer |
No |
The maximum number of entries to return in this request. |
20 |
| NextToken |
string |
No |
The pagination token that indicates the position from which to start reading. Leave this parameter empty to read from the beginning. |
AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
ApiResponse |
||
| RequestId |
string |
The request ID. |
9A51B1DF-96FF-3BCC-B08C-783161D3**** |
| Code |
string |
The status code of the operation. |
200 |
| Message |
string |
The response message. |
Success. |
| TotalCount |
integer |
The total number of records. |
50 |
| Tasks |
array<object> |
The list of scheduled tasks. |
|
|
array<object> |
The scheduled task information. |
||
| ScheduledId |
string |
The scheduled task ID. |
sch-260705-agb***** |
| TaskConfigId |
string |
The task configuration ID. |
tsk-260615-***** |
| TaskName |
string |
The task name. |
DailyDataSyncTask |
| CronExpression |
string |
The cron expression. |
0 0 * * * |
| Status |
string |
The status. |
ACTIVE |
| Version |
integer |
The CAS version number. |
1 |
| InstanceIds |
array |
The list of bound instance IDs. |
|
|
string |
The instance ID. |
acp-2kkkhb8w472e***** |
|
| RunConfig |
object |
The run configuration. |
|
| Skills |
array |
["sk-abc"] |
|
|
string |
|||
| MaxSteps |
integer |
The maximum number of steps. |
10 |
| TimeoutSeconds |
integer |
The timeout period, in seconds. |
3600 |
| ExtraParams |
string |
The extra parameters. |
{"batchSize":"1000"} |
| NextExecutionAt |
string |
The next execution time. |
2026-06-13T00:00:00 |
| LastExecutionAt |
string |
The last execution time. |
2026-06-12T00:00:00 |
| TotalExecutions |
integer |
The total number of executions. |
100 |
| TotalFailures |
integer |
The total number of failures. |
2 |
| GmtCreate |
string |
The creation time. |
2026-01-01T00:00:00 |
| GmtModified |
string |
The modification time. |
2026-06-12T10:00:00 |
| UserPrompt |
string |
The user prompt or task description. |
Execute daily data sync task |
| NextToken |
string |
The pagination token that indicates the position from which to start reading. Leave this parameter empty to read from the beginning. |
AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc**** |
| MaxResults |
integer |
The maximum number of entries to return in this request. |
20 |
Examples
Success response
JSON format
{
"RequestId": "9A51B1DF-96FF-3BCC-B08C-783161D3****",
"Code": "200",
"Message": "Success.",
"TotalCount": 50,
"Tasks": [
{
"ScheduledId": "sch-260705-agb*****",
"TaskConfigId": "tsk-260615-*****",
"TaskName": "DailyDataSyncTask",
"CronExpression": "0 0 * * *",
"Status": "ACTIVE",
"Version": 1,
"InstanceIds": [
"acp-2kkkhb8w472e*****"
],
"RunConfig": {
"Skills": [
""
],
"MaxSteps": 10,
"TimeoutSeconds": 3600,
"ExtraParams": "{\"batchSize\":\"1000\"}"
},
"NextExecutionAt": "2026-06-13T00:00:00",
"LastExecutionAt": "2026-06-12T00:00:00",
"TotalExecutions": 100,
"TotalFailures": 2,
"GmtCreate": "2026-01-01T00:00:00",
"GmtModified": "2026-06-12T10:00:00",
"UserPrompt": "Execute daily data synchronization task"
}
],
"NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****",
"MaxResults": 20
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.