所有错误都将返回下表中最具体、最合适的 HTTP 响应码:
400
错误请求
从客户端收到的请求格式有误。这是 API 提供的最通用响应
401
未授权
您没有授权,无法访问所请求的资源
403
禁止访问
您没有访问所请求资源的权限
404
未找到
找不到所请求的资源。它可能会在稍后可用
405
方法不允许
所请求的资源使用了不受支持的 HTTP 方法
406
不可接受
客户端请求的 Accept 或 Accept-Encoding 类型不可用
409
冲突
由于与现有资源发生冲突,无法完成请求
410
已消失
所请求的资源不再可用,并且将来也不会再可用
411
需要内容长度
所请求的资源要求客户端提供 Content-Length
413
请求实体过大
客户端提供的请求体过大,资源拒绝处理
415
不支持的媒体类型
客户端提供了错误的(或未提供)Content-Type
422
无法处理的实体
请求格式并无问题,媒体类型也可接受,但资源无法处理该请求
429
请求过多
已达到速率限制。更多信息请参见限流部分
500
内部服务器错误
由于意外的内部服务器错误,服务器无法处理您的请求
501
未实现
所请求的资源尚未实现
503
服务不可用
所请求的服务暂时不可用
所有错误都会有一个包含两个字段的标准响应体, 代码 和 消息。还可以使用更多字段,但它们是可选的。
代码
消息
这是错误返回体最简单的形式,客户端可以依赖于每个错误中都包含这些字段。
下面的示例除了标准字段外,还包含与此特定请求相关的错误信息。
这有帮助吗?
{ "code": 429, "message": "您已超过请求次数限制。请稍后再试" }
{ "code": 422, "message": "无法处理的实体", "cause": "验证失败", "errors": [ { "resource": "Issue", "field": "title", "code": "missing_field" }, ... ] }