HTTP 状态码
最近更新：2021-12-15
HTTP 状态码
本文档定义 JPush REST API 的 HTTP 返回码规范。
JPush Push API v3 新版本 API 满足此规范。JPush Report API 也满足此规范。
状态码定义
| Code | 描述 | 详细解释 |
|---|---|---|
| 200 | OK | Success! |
| 400 | 错误的请求 | 该请求是无效的。相应的描述信息会说明原因。 |
| 401 | 未验证 | 没有验证信息或者验证失败 |
| 403 | 被拒绝 | 理解该请求，但不被接受。相应的描述信息会说明原因。 |
| 404 | 无法找到 | 资源不存在，请求的用户的不存在，请求的格式不被支持。 |
| 405 | 请求方法不合适 | 该接口不支持该方法的请求。 |
| 410 | 已下线 | 请求的资源已下线。请参考相关公告。 |
| 429 | 过多的请求 | 请求超出了频率限制。相应的描述信息会解释具体的原因。 |
| 500 | 内部服务错误 | 服务器内部出错了。请联系我们尽快解决问题。 |
| 502 | 无效代理 | 业务服务器下线了或者正在升级。请稍后重试。 |
| 503 | 服务暂时失效 | 服务器无法响应请求。请稍后重试。 |
| 504 | 代理超时 | 服务器在运行，但是无法响应请求。请稍后重试。 |
遵守的规范
- 200 一定是正确。所有异常都不使用 200 返回码
- 业务逻辑上的错误，有特别的错误码尽量使用 4xx，否则使用 400。
- 服务器端内部错误，无特别错误码使用 500。
- 业务异常时，返回内容使用 JSON 格式定义 error 信息。
文档参考
文档内容是否对您有帮助？
