错误返回
更新时间：2024-09-24
当用户访问API出现错误时，会返回给用户相应的错误码和错误信息，便于定位问题，并做出适当处理。请求发生错误时通过Response Body返回详细错误信息，遵循如下格式：
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | String | 表示具体错误类型。 |
| message | String | 有关该错误的详细说明。 |
| requestId | String | 导致该错误的requestId |
示例：
{
"requestId": "3ffd9f45-6908-452d-9f4f-5fb1f5******",
"code": "CommandMissing",
"message": "Command is empty"
}云助手业务错误码
| 错误码 | 错误消息 | HTTP状态码 | 描述 |
|---|---|---|---|
| CommandMissing | Command is empty | 400 | 命令为空 |
| CommandInvalidParamName | A command parameter name is invalid | 400 | 命令参数名称不符合规范 |
| CommandInvalidExecParams | The execution parameter does not match the command parameter | 400 | 执行时参数与命令参数不匹配 |
| CommandMismatchedParams | Mismatched parameter list and content | 400 | 命令内容和参数不匹配 |
| CommandNameAlreadyExisted | Command named {{name}} already existed | 400 | 命令名称已存在 |
| CommandTooManyParams | The number of parameters must be less than 20 | 400 | 参数数量过多 |
| CommandInvalidContentLength | The command content length is invalid | 400 | 命令内容长度不合法 |
| CommandNameMissing | The command name missing | 400 | 缺少命令名称 |
| CommandNotFound | The command not found | 404 | 命令不存在 |
| EmptyFile | The file is empty | 400 | 所上传文件为空 |
| FileNameExceedLimit | The file name exceed the limit | 400 | 文件名称过长 |
| FileSizeExceedLimit | The file exceeds its maximum permitted size | 400 | 文件大小超过上限 |
| FileNotFound | The file does not exist | 404 | 所下载的文件不存在 |
| UnknownActionRunType | Unknown type of action run | 400 | 未知的历史记录类型 |
| UnknownInstanceSelector | TargetSelector is empty | 400 | 未知的实例筛选方式 |
| EmptyInstanceList | The target instance list is empty | 400 | 目标实例列表为空 |
| InstanceCountExceedLimit | The number of target instance exceeds the limit | 400 | 目标实例数量超过上限 |
| ActionRunNotFound | The action run not found | 404 | 执行记录不存在 |
| AgentCountExceedLimit | The number of agent exceed the limit | 400 | 查询Agent数量超过上限 |