超级文档
错误码表
登录
免费注册 / 登录

错误码表

编写人:刘洋
适用版本:行政协同平台 V1.2
更新日期:0000-00-00
确认人:陈静

一、使用约定

接口以响应体中的 code 表示结果,message 给用户阅读,requestId 给值班检索。code 为 0 表示成功。非 0 时页面展示 message 原文,并把 requestId 放在详情里供复制。陈静于 9月14日确认下列文案与四个页面的提示一致。新增错误码由刘洋登记到本表后再发版,避免前端写死未约定的数字。

二、错误码清单

三、分段规则

  1. 0 仅表示成功,业务数据放在 data 字段。
  2. 40001 至 40019 表示登录、令牌和权限,由网关或鉴权逻辑返回。
  3. 40020 至 40059 表示四项业务的校验和冲突,由对应服务返回。
  4. 50000 至 50099 表示未预期的服务错误,message 保持统一文案,细节只进日志。

四、响应示例

9月18日张伟重复预订 3 楼东侧会议室 14:00 至 15:00 时,接口返回下列内容,数据库未新增单据。

{
"code": 40021,
"message": "该时段已被占用",
"data": null,
"requestId": "REQ-0918-118"
}

成功响应的 code 为 0,data 中带单据号。50000 的 message 固定为「系统繁忙,请稍后再试」,英文堆栈只出现在服务器日志,日志保留 14 天。

五、页面展示

  1. 40001 时清除本地令牌并打开登录页,登录成功后回到原先要办理的页面。
  2. 40021、40031、40041、40051 时停留在当前表单,标出对应字段,已填内容保留。
  3. 40003 时展示提示并提供返回首页的按钮,表单内容不提交。
  4. 50000 时展示统一文案和 requestId,员工把该编号告诉刘洋即可定位日志。
  5. code 为 0 时展示「操作已完成」,并在 2 秒后刷新单据状态。

六、新增与变更

新业务规则需要新错误码时,刘洋先选用该服务分段中尚未占用的号码,写明含义、场景和页面提示,再提交给陈静确认文案。确认后的同一版本同时更新服务和页面。已发布的 code 保持含义不变,文案调整需让陈静在 2 个工作日内确认。9月以来新增 40041 与 40051 两个号码,分别在访客和用品联调中使用了 6 次和 4 次。

陈静于 9月14日把 8 条文案交给前端,页面与本表逐字一致。张伟在 9月18日重复预订时核对 40021,列表仍只有 BK-0000-118 一条。周敏在库存为 1 时申领 2 本记事贴,收到 40051,库存保持 1。刘洋抽查 9月日志,50000 出现 2 次,均因通知超时,重试后单据状态正确。前端对未知 code 展示「请联系刘洋」并附上 requestId。9月联调期间未知号码出现 0 次。一旦出现表外号码,刘洋当日补登本表并同步陈静,避免页面长期使用兜底文案。