1.3.2 公共响应结果
优质
小牛编辑
140浏览
2023-12-01
HTTP状态码
返回的 HTTP 状态码大于等于200小于300表示成功；大于等于400小于500为客户端错误；大于500为服务端错误
| HTTP状态码 | 描述 | 处理建议 |
|---|---|---|
| 200 | 请求处理成功 | 用户请求处理成功（但查询API有可能返回空结果，需要另行判断） |
| 400 | 请求处理失败 | 用户发出的请求的参数或格式有错误 |
| 401 | 身份验证失败 | 检查请求Header中的X-Ca-Key是否正确，或合作服务是否到期 |
| 403 | 权限不足，或被流控 | 确认是否有操作该资源的权限 |
| 404 | 请求地址错误 | 用户请求的URL不存在 |
| 405 | 请求处理失败 | 由于请求参数错误，导致处理失败，检查API用法是否错误 |
| 500 | 服务处理失败 | 服务端处理请求时失败，需要查看返回报文中对错误的描述，或者将request_id提交给客服查询 |
| 503 | 服务不可用 | 请稍后重试，或者联系客服 |
Header参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| X-Ca-Request-Id | String | 请求唯一ID,请求被服务端接收后会，生成请求ID并通过响应头返回给客户端，建议记录此请求ID，可用于问题排查与跟踪 | 4CC92CC8-A71D-4C6D-BD36-D4B736385C92 |
| X-Ca-Error-Message | String | 返回的错误消息，返回结果正常时不会传输该信息 | Invalid Url |
数据格式
返回的数据格式为JSON（所有示例中的JSON是为了阅读方便而做了格式化，实际调用时是没有进行换行、缩进等处理的）。
注意：当返回的 HTTP状态码为 2xx时，返回的数据会进行加密处理；其他情况返回数据都不进行加密处理。
异常情况返回数据格式
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| timestamp | String | 错误发生时服务器的时间戳（格式为：yyyy-MM-dd HH:mm:ss） | 2016-02-24 19:55:44 |
| error | String | 错误描述 | Method Not Allowed |
| message | String | 错误详情 | Request method 'POST' not supported |
示例
- 正常情况 处理成功，并返回数据，HTTP状态码:200，返回Body数据（加密前）:
{nm:"客户名称",no:"客户号"} - 异常情况
{ "timestamp": "2016-02-24 19:55:44", "error": "Method Not Allowed", "message": "Request method 'POST' not supported" }