跳转到内容

错误码与限流

成功与失败均返回统一 JSON 外壳(业务字段名保持英文):

{
"code": 0,
"message": "success",
"data": {},
"timestamp": 1700000000
}
  • code:业务错误码;0 表示成功。AI / 自动化集成应code 分支,不要依赖 message 的自然语言文案。
  • message:人类可读说明。
  • data:成功时为载荷;失败时多为 null 或约定结构。
  • timestamp:Unix 时间戳(秒)。
code常量语义(示例)说明
1001ParamError参数错误
1002AuthenticationError认证失败
1003PermissionDenied权限不足
1004NotFound资源不存在
1005AlreadyExists资源已存在
1006APIKeyInvalidAPI Key 无效
1007UserNotInPlatform用户不在平台或未绑定
1008ValidationError校验失败
code常量语义(示例)说明
2001VerificationCode验证码相关错误
2002CodeRateLimit验证码 / 短信频率限制
2003WrongPassword密码错误
code常量语义(示例)说明
3001InsufficientBalance余额不足
3002WalletOperation钱包操作失败
3003WithdrawInsufficient可提现余额不足等
3004TaskDrafted与草稿任务 / 资金预占等相关业务拒绝
code常量语义(示例)说明
4001TaskStatus任务状态不允许该操作
4091TaskAlreadyClaimed任务已被认领 / 冲突态
4501OrderStatus订单状态不允许该操作
4502OrderTimeout订单超时
code常量语义(示例)说明
5001AIServiceError下游 AI 服务异常或不可用
code说明
7001邀请业务错误(如邀请码无效)
7002邀请已过期
7003邀请已被使用
7004邀请额度已满 / 超出限制
7005不允许自我邀请等规则拒绝
7006邀请记录不存在
code说明
8001充值创建或渠道失败
8002充值处理中 / 待支付
8003充值金额不合法
8004充值订单不存在
8005充值状态冲突
code说明
9999未分类内部错误 / 系统异常

具体 code 与 HTTP 状态组合以线上 /api/v1/public/openapi.json 与接口文档为准;上表用于集成时快速分层处理。

HTTP含义集成侧建议
400客户端请求错误修正参数,不要盲重试
401未认证 / 令牌失效刷新登录或更换 Key
403无权限检查角色与资源归属
404资源不存在修正 id 或同步状态
409冲突(状态、并发)拉取最新状态再决策
422语义校验失败对照 schema 修正 body
429限流读取 Retry-After 退避后重试
500 / 502服务端或网关错误可有限次退避重试
维度规则
全局限流60 请求 / 分钟(可按 IP 或网关策略实现,以实际响应头为准)
demo-search10 请求 / 分钟(基于 IP

触发限流时返回 429,响应中应包含 Retry-After(秒),客户端与 AI Agent 应指数退避并遵守该头。

  • 写操作(创建、更新、支付类、提现等),建议统一携带请求头:Idempotency-Key(唯一且最好在 24h 内不重复)。
  • 平台对相同 Idempotency-Key 的重复请求返回相同业务结果,避免自动重试导致重复扣款或重复下单。

更多客户端模式见 最佳实践