DeleteAgent
Deletes a specified agent.
Operation description
Creators can delete the agents they created.
After deletion, the agent can no longer be queried, updated, or run.
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.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
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ada:DeleteAgent |
delete |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Name |
string |
Yes |
The name of the agent to be deleted. |
code-review-agent |
Request example
{
"Name": "code-review-agent"
}
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The result of deleting an agent. |
||
| Success |
boolean |
Indicates whether the agent was successfully deleted. A successful response always returns |
true |
| RequestId |
string |
The request ID used for Tracing Analysis and troubleshooting. |
0A1B2C3D-4E5F-6789-ABCD-EF0123456789 |
Sample success response
{
"Success": true,
"RequestId": "0A1B2C3D-4E5F-6789-ABCD-EF0123456789"
}
Examples
Success response
JSON format
{
"Success": true,
"RequestId": "0A1B2C3D-4E5F-6789-ABCD-EF0123456789"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidParameter | The specified parameter is invalid. | |
| 401 | Unauthenticated | Authentication required. | |
| 500 | InternalError | Internal server error. | |
| 403 | Agent.Forbidden | You are not authorized to operate the specified Agent. | |
| 503 | ServiceUnavailable | The service is not ready or temporarily unavailable. | |
| 504 | ServiceTimeout | A required service timed out. | |
| 504 | Agent.OperationResultUnknown | The Agent operation result is unknown. |
See Error CodesError Codes for a complete list.
Release notes
See Release NotesRelease Notes for a complete list.