API 参考

状态码与故障处理

先检查 HTTP 状态,再根据业务 code 定位原因。所有错误响应都应包含可用于排查的 requestId。

2xx

请求成功

可以继续处理业务数据

4xx

请求需修正

检查认证、参数与调用频率

5xx

服务暂不可用

有限重试并保留请求标识

HTTP业务 code名称说明建议操作
2000请求成功请求已完成,业务数据位于 data 字段。继续处理返回数据
40040001参数错误缺少必填字段或字段类型不正确。根据 details 修正参数
40140101认证失败密钥缺失、无效或已经被吊销。检查 Authorization 请求头
40340301权限不足当前方案无权访问该接口或数据范围。检查方案与接口权限
40440401资源不存在路由、接口编号或目标资源不存在。核对请求路径和标识
42942901请求过快当前时间窗口的请求数已经超过限制。读取 Retry-After 后重试
50050001服务异常服务暂时无法完成请求。有限重试并保留 requestId
50350301上游不可用目标数据源临时维护或响应不稳定。延迟重试或稍后查询

错误响应结构

{
  "code": 42901,
  "message": "rate limit exceeded",
  "details": { "retryAfter": 2 },
  "requestId": "req_local_8f2a"
}

故障处理顺序

  1. 1记录 HTTP 状态、业务 code 和 requestId
  2. 2确认请求参数、密钥与当前积分
  3. 3根据 Retry-After 执行有限重试
  4. 4持续失败时携带完整上下文提交工单