Error response
Updated at:2025-10-20
When an error is encountered during API access, the corresponding error code and information will be returned to identify and address the issue. If a request error occurs, detailed error information is provided within the Response Body, formatted as follows:
| Parameter name | Types | Description |
|---|---|---|
| code | String | Specify the exact error type. |
| message | String | Provide a detailed description of the error. |
| requestId | String | The requestId causing this error |
Example:
JSON
1{
2 "requestId": "3ffd9f45-6908-452d-9f4f-5fb1f5******",
3 "code": "CommandMissing",
4 "message": "Command is empty"
5}
Cloud Assistant business error codes
| Error code | Error message | HTTP status code | Description |
|---|---|---|---|
| CommandMissing | Command is empty | 400 | Command is empty |
| CommandInvalidParamName | A command parameter name is invalid | 400 | The command parameter name does not conform to the specifications |
| CommandInvalidExecParams | The execution parameter does not match the command parameter | 400 | The execution parameter does not match the command parameter |
| CommandMismatchedParams | Mismatched parameter list and content | 400 | The command content and parameters do not match |
| CommandNameAlreadyExisted | Command named {{name}} already existed | 400 | Command name already existed |
| CommandTooManyParams | The number of parameters must be less than 20 | 400 | Excessive parameter count |
| CommandInvalidContentLength | The command content length is invalid | 400 | The command content length is invalid |
| CommandNameMissing | The command name missing | 400 | Missing command name |
| CommandNotFound | The command not found | 404 | Command is not found |
| EmptyFile | The file is empty | 400 | The uploaded file is empty |
| FileNameExceedLimit | The file name exceed the limit | 400 | The file name is too long |
| FileSizeExceedLimit | The file exceeds its maximum permitted size | 400 | The file size exceeds its upper limit |
| FileNotFound | The file does not exist | 404 | The downloaded file does not exist |
| UnknownActionRunType | Unknown type of action run | 400 | Unknown type of action run |
| UnknownInstanceSelector | TargetSelector is empty | 400 | Unknown instance selection method |
| EmptyInstanceList | The target instance list is empty | 400 | The target instance list is empty |
| InstanceCountExceedLimit | The number of target instance exceeds the limit | 400 | The count of target instance exceeds the upper limit |
| ActionRunNotFound | The action run not found | 404 | The execution record is not found |
| AgentCountExceedLimit | The number of agent exceed the limit | 400 | The number of agent exceeds the upper limit |
