Skip to main content

错误编码

接口响应以HTTP 标准状态码+系统业务编码进行响应,具体如下:

1、当接口响应错误异常码时,Status字段会以JSON的内容进行响应,例如:

2、当接口无系统异常情况时,内部的业务处理异常,那么请参考业务编码,响应业务编码状态下,HTTP状态码为200

{
"code": 401, // 业务错误编码
"message": "AccessDenied",
"data": null
}

HTTP状态码

在部分的业务场景下,服务端接口会同时享有HTTP状态码,非200的状态码需要开发人员关注

错误编码明细如下表所示:

HTTP状态吗状态(错误)原因
200SUCCESS成功
401AccessDenied请求中的 ApiKey 错误,鉴权失败
400InvalidParameter请求参数非法,格式不符合要求
413RequestTooLarge接入层网关返回请求体过大错误,错误如果是由mse网关层直接拦截,则没有 code,并且 message 不能自定义。如果是restful网关拦截返回code。
429RateQuotaLimit触发平台限流措施
429InsufficientAccountBalance账户余额不足
500InternalError系统内部异常,请稍后再试

业务编码

HTTP状态码为200的情况下,同时判断code编码为8200,则表示都成功

在系统业务处理的过程中,对于正常200状态码,也可能会出现业务处理异常的情况,此时,会在响应的结果code编码中,会响应不同的业务编码

业务编码定义如下:

业务编码状态(错误)原因
8200SUCCESS成功
8401METHOD_NOT_ALLOWED不允许的操作
8402REQUEST_PARAMS_NOT_VALID请求参数非法
8403AUTHENTICATION_FAILED权限校验错误
8404NOT_FOUND_RESOURCE没有找到资源
8405DATA_REQUIRED_NOT_FOUNT请求数据不存在
8409DATA_REQUIRED_ERROR请求数据错误
8406REQUEST_TIME_EXPIRES_TIMEOUT请求已超时
8407REQUEST_INVALID请求非法
8408REQUEST_EXPIRED请求token过期
8410DUPLICATION_OPERATION重复操作
8407CAN_NOT_DELETE不允许删除
8302NOT_LOGIN未登录
8500INTERNAL_SERVER_ERROR服务器内部错误