Modifies an agent scheduled task.
Try it now
Test
RAM authorization
Request syntax
POST HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ScheduledId |
string |
Yes |
The scheduled task ID. |
sch-260705-agb***** |
| TaskVersion |
integer |
Yes |
The CAS version number. |
1 |
| TaskName |
string |
No |
The task name. |
NewTaskName |
| UserPrompt |
string |
No |
The user prompt. |
Execute daily data synchronization task |
| CronExpression |
string |
No |
The cron expression. |
0 30 * * * |
| InstanceIds |
array |
No |
The list of instance IDs. |
["acp-5hh431emkt6u*****"] |
|
string |
No |
The list of cloud phone instance IDs. A maximum of 3 instances can be associated. |
acp-5hh431emkt6u***** |
|
| Status |
string |
No |
Switches the status. Valid values: ACTIVE and DISABLED. |
ACTIVE |
| RunConfig |
object |
No |
The run configuration. |
{"maxSteps":10,"timeoutSeconds":3600} |
| Skills |
array |
No |
The list of skill IDs. A maximum of 1 skill ID is supported. The value overwrites aim_task_config.run_config after modification. |
["sk-abc"] |
|
string |
No |
|||
| MaxSteps |
integer |
No |
The maximum number of execution steps. |
10 |
| TimeoutSeconds |
integer |
No |
The timeout period, in seconds. |
3600 |
| ExtraParams |
string |
No |
The extended parameter JSON string. |
{"batchSize":"1000"} |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
ApiResponse |
||
| RequestId |
string |
The request ID. |
9A51B1DF-96FF-3BCC-B08C-783161D3**** |
| Code |
string |
The API status code. |
200 |
| Message |
string |
The response message. |
Success. |
| TotalCount |
integer |
The total number of records. |
1 |
| Tasks |
array<object> |
The list of modification results. |
|
|
array<object> |
The task. |
||
| ScheduledId |
string |
The scheduled task ID. |
sch-260705-agbx***** |
| NewVersion |
integer |
The updated CAS version number. |
2 |
| InstanceResults |
array<object> |
The list of batch delivery results for instance scheduled tasks. |
|
|
object |
The delivery result of an instance scheduled task. |
||
| InstanceId |
string |
The instance ID. |
acp-4dkmkip0l0uw***** |
| Success |
boolean |
Indicates whether the operation is successful. |
true |
| ErrorMessage |
string |
The error message. |
Instance not found. |
Examples
Success response
JSON format
{
"RequestId": "9A51B1DF-96FF-3BCC-B08C-783161D3****",
"Code": "200",
"Message": "Success.",
"TotalCount": 1,
"Tasks": [
{
"ScheduledId": "sch-260705-agbx*****",
"NewVersion": 2,
"InstanceResults": [
{
"InstanceId": "acp-4dkmkip0l0uw*****",
"Success": true,
"ErrorMessage": "Instance not found."
}
]
}
]
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.