公共错误码

最近更新时间:2023-06-26 16:50:20 前往 Coding 编辑

导出文档

功能说明

如果返回结果中 code 的值不为 0,则表示调用 API 接口失败。例如:

{
    "requestId": "9ff4a6067a2ce1ad2b55fde9b3ab6663",
    "code": 10000001,
    "msg": "权限校验失败",
}

其中 code msg 表示该错误的具体信息。

错误码设计

code 为 0 表示成功,成功时 msg 固定返回 OK 其余情况代表错误,一般为 8 位数字

  • 第 1 位表示错误类型,1 表示本系统错误,2 表示三方系统错误
  • 第 2-3 位表示服务类目,比如 00 表示公共服务,01 表示 cloud 服务
  • 第 4-5 位表示模块类目,比如 00 表示公共模块,01 表示 asr 模块 02 表示 tts 模块
  • 第 6-8 位表示具体错误,比如 001 表示参数校验错误

错误码列表

错误码说明
10000001权限校验失败
10000002参数校验错误
10000003内部错误
10000004用户不存在
10000005接口已下线
10000006手机号未注册,无法登录
10000007操作失败
10000008请求的次数超过了频率限制
10000009资源不存在
10000010Redis 异常
10000011请求方式不合法
10000012密钥停用或不存在
10000013签名过期