UpdateOptimizeRun
Cancels a run or retries a failed artifact application. To cancel a run, set status to Cancelled. To retry a failed artifact application, set extra.application.action to retry and do not specify status.
Try it now
Test
RAM authorization
Request syntax
PUT /agentspace/{agentSpace}/optimizetasks/{optimizeTaskName}/runs/{optimizeRunId} HTTP/1.1
Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| agentSpace |
string |
No |
The name of the AgentSpace. |
my-agent-space |
| optimizeTaskName |
string |
No |
The name of the optimization task. |
efficiency-analysis |
| optimizeRunId |
string |
No |
The ID of the execution instance. |
or-20260812-0001 |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| body |
object |
No |
The run update request, which is used to cancel a run or retry a failed artifact application. |
|
| extra |
object |
No |
The extra parameters. To retry a failed artifact application, set application.action to retry and do not specify status. Do not specify this field when canceling a run. |
{"application":{"action":"retry"}} |
|
any |
No |
The value of a field in the artifact application retry instruction. The value of the application field is an object that contains action=retry. |
{"action":"retry"} |
|
| status |
string |
No |
The status. Only Cancelled is supported when canceling a run. The execution status is maintained by the server. Do not specify this field when retrying an artifact application. |
Succeeded |
| clientToken |
string |
No |
The idempotency token. |
a1b2c3d4-1234-5678-90ab-cdef12345678 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response data. |
||
| optimizeRunId |
string |
The ID of the execution instance. |
or-20260812-0001 |
| requestId |
string |
The ID of the request. |
9ACFB10A-1B2C-3D4E-5F6G-7H8I9J0K1L2M |
Examples
Success response
JSON format
{
"optimizeRunId": "or-20260812-0001",
"requestId": "9ACFB10A-1B2C-3D4E-5F6G-7H8I9J0K1L2M"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.