错误参考
标准错误对象
多数错误响应为 JSON,常见结构:
{ "error": "Human-readable message", "code": "OPTIONAL_MACHINE_CODE", "details": {}}| 字段 | 说明 |
|---|---|
error | 面向日志与 UI 的简短说明 |
code | 可选稳定机读码(如 LIMIT_EXCEEDED、FEATURE_REQUIRED) |
details | 可选上下文(限额、校验字段等) |
并非所有接口都返回 code / details;以 error 为主。
HTTP 状态码
| 状态码 | 典型场景 |
|---|---|
| 400 | JSON 无效、缺少必填字段、URL 非法 |
| 401 | 需要认证但凭证缺失或无效 |
| 403 | 无权限(资源归属、套餐功能或配额限制) |
| 404 | 路由或资源不存在(端点、日志、密钥等) |
| 413 | Webhook 正文超过套餐允许大小 |
| 429 | 速率或每日配额超限 |
| 500 | 服务器内部错误 |
示例
401:
{ "error": "Unauthorized" }403 功能未开通:
{ "error": "This feature requires a higher subscription", "code": "FEATURE_REQUIRED", "upgradeUrl": "/pricing"}429:
{ "error": "Daily request limit reached", "limit": 5000, "current": 5000}