protocal://domain[:port][/path][?queries]
GET /path HTTP/1.1
Host: api.example.com
Date: <gmt date>
Authorization: <signature value>
{
"status": 200,
"code": 2000000,
"success": true,
"message": "OK",
"tracer": "fb6cf58101834fcc880925a723cbda5d",
"data": ...
}
字段 | 描述 |
---|---|
status | HTTP 状态码 |
code | 错误码 |
success | 业务是否成功 |
message | 提示消息 |
tracer | 示踪符,请求ID |
data | 响应数据 |
名称 | 示例值 | 描述 |
---|---|---|
Authorization | UPIv2 | 在非匿名请求中用于验证请求合法性的认证信息。详情请参阅 验证请求 |
Content-Length | application/json | 根据 RFC 2616 定义的消息长度(不包含标头)。 |
Content-Type | 567 | 根据 RFC 2616 定义的请求正文内容类型。 |
Content-MD5 | 根据 RFC 1864 定义的请求正文内容以 Base64 编码的 MD5 摘要。 | |
Date | Mon, 10 Jul 2023 13:07:29 GMT | HTTP 1.1 协议规定的 GMT 时间,必须为 RFC1123 格式,不能为空。 |
Host | api.example.com | 访问域名 |
名称 | 示例值 | 描述 |
---|---|---|
Content-Length | 567 | 根据 RFC 2616 定义的 HTTP 响应内容长度。 |
Content-Type | application/json | 根据 RFC 2616 定义的 HTTP 响应内容类型。 |
Connection | keep-alive | 标明客户端和服务端之间的连接状态。如 keep-alive、close |
Date | Mon, 10 Jul 2023 13:07:29 GMT | HTTP 1.1 协议规定的 GMT 时间。 |
Server | U+OpenAPI | 创建响应的服务器名称。 |
错误代码 | HTTP 状态码 | 描述 |
---|---|---|
4000000 | 400 Bad Request | 参数错误或请求异常 |
4030000 | 403 Forbidden | 拒绝访问 |
4040000 | 404 Not Found | 资源不存在 |
4050000 | 405 Method Not Allowed | 不支持的请求方法 |
4090000 | 409 Conflict | 数据冲突 |