API Error Code

API 常用状态码描述

1)     HTTP状态码表

结果码参照http协议状态码制定,下表状态码表示接口必定用到,其它状态码请参考标准HTTP状态码表。

状态码 状态消息 含义
200 OK 请求成功可按业务解析结果
400 Bad request

(坏请求)

请求的数据未按要求提供
401 Unauthorized

(未授权)

客户端未授权或授权无效
403 Forbidden 服务器已经理解请求,但是拒绝执行它。

此时需要根据错误码表查询具体的错误原因

404 Not Found

(未找到)

找不到资源
500 Server Error

(服务器错误)

服务器发生故障
503 Service Unavailable

(服务器临时维护)

服务器临时维护

 

 

2)     错误编码

当接口 HTTP Status 状态码响应为 403 时,表示当前请求的业务不能按要求完成,响应不能完成此请求的错误描述。

 

错误码查阅 “系统级错误编码表” 与 “业务级错误编码表”。

 

错误返回值格式: JSON

{

"code" : "105",

"message" : " IP requests out of rate limit"

}

 

 

3)     系统级错误编码表

系统级错误编码由 1 – 999 ,保留为通用级业务响应,不允许业务模块对其进行使用。

错误码 含义
100 Too many pending tasks, system is busy

任务过多,系统繁忙

101 Job expired

任务超时

102 Illegal request

非法请求

103 Request api not found

接口不存在

104 HTTP method is not suported for this request

请求的HTTP METHOD不支持,是否选择了正确的POST/GET方式

105 IP requests out of rate limit

IP请求频次超过上限

106 User requests out of rate limit

用户对资源的请求频次超过上限

 
999  

 

 

 

 

4)     业务错误编码表

业务级错误编码为 1000 - 9999 范围,其中前两位表示模块,后两位表示具体错误。

 

错误代码1001 的解释说明

10 01
服务模块代码 具体错误代码

模块

10 账号
11 订单
12 送货单
13 出库单
14 物流单
15 入库单
16 结算单
17 发票

 

 

错误码 含义
1000 账号问题,具体错误原因查阅message
1001 账号被冻结
1100 订单问题,具体错误原因查阅message
1101 订单不存在
1102 订单当前状态不允许进行此操作
1200 送货单问题,具体错误原因查阅message
1300 出库单问题,具体错误原因查阅message
1400 物流单问题,具体错误原因查阅message
1500 入库单问题,具体错误原因查阅message
1600 结算单问题,具体错误原因查阅message
1700 发票问题,具体错误原因查阅message
   

 

 

 

 

此条目发表在technologys分类目录,贴了标签。将固定链接加入收藏夹。