常见错误代码

在错误情况下,我们需要处理两方面内容。一方面是供人工解读,另一方面是供 API 使用者(机器)解释并采取适当行动。对人工来说,可以返回一条适当的可读错误信息。对机器来说,根据状态码和导致错误的“字段”,它可以高亮显示 UI 中的相关内容或执行其他操作。

批量 API 错误响应示例

错误场景代码HTTP 代码响应示例(response_status 对象内容)
输入的 Id 或名称不存在、不被使用或用户无权设置该值4001400 {
禁止 / 用户无权执行该操作4002403 {
关闭规则违反4003400 {
内部错误(无法向用户发送具体错误,如某些异常)4004500{
引用存在。(无法删除实体,因为它被其他模块使用中)4005400{
无效的 URL 或资源未找到,例如 /requests/10 ,且 id 为 10 的请求未找到4007404{
不唯一4008400{
尝试编辑不可编辑字段(某些字段可在添加时赋值,但不可编辑,例如 status in_progress)4009400{
尝试编辑内部字段4010400{
没有此字段4011400{
未提供必填字段的值4012400{
不支持的内容类型4013415{
尝试编辑只读字段4014400{
达到 API 速率限制4015400{
已在回收站中4016400{
不在回收站中4017400{
当前许可证不允许7001400{