HTTP 状态码

本文档定义 UMS REST API 的 HTTP 返回码规范。

状态码定义

Code 描述 详细解释
200 请求成功 请求成功
400 错误的请求 该请求是无效的。相应的描述信息会说明原因。
401 鉴权失败 没有验证信息或者验证失败
403 被拒绝 理解该请求,但不被接受。相应的描述信息会说明原因。
500 内部服务错误 服务器内部出错了。请联系我们尽快解决问题。

遵守的规范

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

文档参考


Copyright 2011-2020, jiguang.cn, All Rights Reserved.
粤ICP备12056275号-13 深圳市和讯华谷信息技术有限公司

Documentation built with MkDocs.