错误处理
APIJSON 在返回 API 请求时使用传统的 HTTP 响应代码。
2xx 范围内的代码表示请求成功,而 4xx 范围内的响应表示由于您提供的信息(例如无效的查询参数或身份验证令牌)而出现错误。
常见错误码:
错误码 | 描述 |
200 | 确定 - 响应成功 |
400 | 错误请求 - 通常是由于查询参数无效 |
401 | 未经授权 - 通常是未提供有效的API令牌 |
403 | 未经授权的请求 - 未正确设置权限 |
404 | 未找到 - 请求的站点或环境通常无效 |
429 | 请求过多 - 您发出的请求过多,速度变慢 |
500 | 内部服务器错误 - 服务器端出现了问题 |
典型的APIJSON错误如下,code返回非200,message为错误的具体信息。
{
"code": "500",
"message": "request_method_not_supported",
"data": null
}
A0301:Api-Token未设置
当请求头未设置Api-Token时,或设置的Api-Token无效时。接口返回错误码A0301。
{
"code": "A0301",
"message": "访问未授权",
"data": null
}
1006:参数错误:数据库驱动执行异常
出现该错误时,大多情况下是由于请求参数中涉及到的数据库表名发生错误。
{
"code": "1006",
"message": "数据库驱动执行异常SQLException,非 Log.DEBUG 模式下不显示详情,避免泄漏真实模式名、表名等隐私信息",
"data": null
}
500:系统异常
500错误可能发生在多种情况下,只要服务器发生异常,都会报500错误。