API中心 API Hub-可用性:API响应状态码应使用规范的HTTP状态码

时间：2025-01-26 10:36:32

API中心 API Hub API生产

本条规则是MUST类型的基本规则，可保障API的高可用性。

API响应所使用的状态码应使用规范的HTTP状态码，状态码所表达的状态与API响应状态保持一致。

具体的HTTP状态码使用可参考RFC 7231（Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content），常用状态码如表1所示。

表1 常用状态码
状态码	状态码表示	状态码详细信息
200	OK	执行成功，如：查询成功响应。
201	Created	创建成功，如：创建记录成功。
400	Bad Request	客户端请求语义有误，当前请求无法被服务器理解或请求参数有误。
401	Unauthorized	当前请求需要用户验证，需要用户提供Token进行认证。
403	Forbidden	禁止访问某些资源，如权限不足时无法查询对应的信息。
404	Not Found	无法找到对应资源，如资源不存在。
405	Method Not Allowed	HTTP方法不能被用于请求相应的资源如：HTTP方法要求POST方法，请求中使用了GET方法。
406	Not Acceptable	请求资源的内容特性无法满足请求头中的条件。
413	Payload Too Large	请求提交的实体数据大小超过了服务器够处理的范围。
414	URI Too Long	请求的URI长度超过了服务器能够解释的长度。
415	Unsupported Media Type	当前请求的方法和所请求的资源，请求中提交的实体并不是服务器中所支持的格式。
500	Internal Server Error	服务器遇到了一个未曾预料的状况，导致了它无法完成对请求的处理。通常是服务器内部产生了错误，导致处理失败。
502	Bad Gateway	代理服务器尝试执行请求时，从上游服务器接收到无效的响应。