HTTP 状态码

本文档定义 JPush REST API 的 HTTP 返回码规范。JPush Push API v3 新版本 API 满足此规范。JPush Report API 也满足此规范。

状态码定义

Code描述详细解释
200OKSuccess!
400错误的请求该请求是无效的。相应的描述信息会说明原因。
401未验证没有验证信息或者验证失败
403被拒绝理解该请求，但不被接受。相应的描述信息会说明原因。
404无法找到资源不存在，请求的用户的不存在，请求的格式不被支持。
405请求方法不合适该接口不支持该方法的请求。
410已下线请求的资源已下线。请参考相关公告。
429过多的请求请求超出了频率限制。相应的描述信息会解释具体的原因。
500内部服务错误服务器内部出错了。请联系我们尽快解决问题。
502无效代理业务服务器下线了或者正在升级。请稍后重试。
503服务暂时失效服务器无法响应请求。请稍后重试。
504代理超时服务器在运行，但是无法响应请求。请稍后重试。

遵守的规范

  • 200 一定是正确。所有异常都不使用 200 返回码
  • 业务逻辑上的错误，有特别的错误码尽量使用 4xx，否则使用 400。
  • 服务器端内部错误，无特别错误码使用 500。
  • 业务异常时，返回内容使用 JSON 格式定义 error 信息。

文档参考