状态码与错误码
当 Genstore 接收到 REST API 请求时,系统将根据请求的处理结果在响应中返回相应的 HTTP 状态码,帮助开发者快速识别请求状态。
正常响应
当应用请求 REST API 接到正常响应时,HTTP 状态码是 2xx,并返回响应内容。这表明请求已被成功接收、理解并处理。
示例如下:
HTTP Status: HTTP/1.1 200 OK
HTTP Body:
json
{ "customer": {"id":123456, "name": "book"} }
异常响应
当应用请求 REST API 接到异常响应时,HTTP 状态码是非 2xx,并返回异常提示,示例如下:
HTTP Status: HTTP/1.1 400 Bad Request
HTTP Body:
json
{"error": "Amount must be less than net payment", "order": {...}}
异常响应总是包含一个 error
字段,描述当前请求的异常信息。
具体含义参考下文的响应状态码表。
REST API 响应状态码表
状态码 | 状态描述 | 类型 | 具体说明 |
---|---|---|---|
200 | OK | 标准 | 请求已成功 |
201 | Created | 标准 | 请求成功,资源已创建 |
202 | Accepted | 标准 | 请求已接受,处理将异步进行 |
204 | No Content | 标准 | 请求成功,但无返回内容 |
205 | Reset Content | 标准 | 请求成功,但不返回内容并重置表单 |
303 | See Other | 标准 | 请求已重定向至其他资源 |
400 | Bad Request | 标准 | 请求格式错误,服务器无法处理请求 |
401 | Unauthorized | 标准 | 请求未授权,认证失败 |
402 | Payment Required | 标准 | 需要支付以解除资源限制,例如店铺冻结 |
403 | Forbidden | 标准 | 禁止访问请求的资源 |
404 | Not Found | 标准 | 请求的资源不存在 |
405 | Method Not Allowed | 标准 | 请求方法不被允许 |
406 | Not Acceptable | 标准 | 请求的类型不被支持 |
409 | Resource Conflict | 标准 | 请求的资源冲突,无法完成请求 |
414 | URI Too Long | 标准 | 请求的 URI 超过服务器处理能力 |
415 | Unsupported Media Type | 标准 | 请求的媒体类型不被支持 |
422 | Unprocessable Entity | 标准 | 请求的实体无法处理,例如:参数无效 |
423 | Locked | 标准 | 资源被锁定,无法访问 |
429 | Too Many Requests | 标准 | 请求频率超出限制 |
500 | Internal Server Error | 标准 | 服务器内部错误 |
501 | Not Implemented | 标准 | 服务不支持该请求方法 |
502 | Bad Gateway | 标准 | 网关错误 |
503 | Service Unavailable | 标准 | 服务暂时不可用 |
504 | Gateway Timeout | 标准 | 网关请求超时 |
530 | Origin DNS Error | 非标 | DNS 解析错误 |
540 | Temporarily Disabled | 非标 | 服务端暂时禁用 |
783 | Unexpected Token | 非标 | Token 错误 |
- 标准类型:遵循 HTTP 协议的标准状态码。
- 非标类型:Genstore 自定义的状态码,专门用于处理平台业务中的特定情况。