通用错误码说明 最后更新时间: 2024年08月30日
响应体格式
响应体格式均为json
由于出现平台类异常时,返回结构比较特殊,故使用方需先进行平台类异常判断,判断规则为status字段值不为空且明确为0
名称 | 含义 | 规则说明 |
status | 返回结果状态值 | 失败时返回值为 0 |
info | 异常信息描述 | |
infocode | 异常码 | 参照异常Code表 |
响应示例
{
"status": "0",
"info": "INVALID_USER_KEY",
"infocode": "10001"
}
无平台类异常时,则返回结构如下
名称 | 含义 | 规则说明 | |
code | 返回结果状态值 | 返回值为 0 或 1,0 表示请求失败;1 表示请求成功。 | |
message | 返回状态说明 | 当 status 为 0 时,message 会返回具体错误原因,否则返回“Successful”。详情可以参阅info状态表 | |
timestamp | 服务时间戳 | ||
data | 返回结果数据 | 结果对象,可以是任意类型,取决于具体的API定义 | |
resourceId | 示例数据 | ||
workMapId | 示例数据 |
响应示例
{
"code": 1,
"data": { "workMapId": "10032091369864947", "resourceId": "200320913458048461" },
"message": "Successful",
"result": true,
"timestamp": 1656297098088
}
平台类异常码对照表
infocode | info返回值 | 状态描述 | 问题排查策略 |
10000 | OK | 请求正常 | 请求正常 |
10001 | INVALID_USER_KEY | key不正确或过期 | 开发者发起请求时,传入的key不正确或者过期 |
10002 | SERVICE_NOT_AVAILABLE | 没有权限使用相应的服务或者请求接口的路径拼写错误 | 1.开发者没有权限使用相应的服务,例如:开发者申请了WEB定位功能的key,却使用该key访问逆地理编码功能时,就会返回该错误。反之亦然。 2.开发者请求接口的路径拼写错误。例如:正确的https://restapi.amap.com/v3/ip在程序中被拼装写了https://restapi.amap.com/vv3/ip" |
10003 | DAILY_QUERY_OVER_LIMIT | 访问已超出日访问量 | 开发者的日访问量超限,被系统自动封停,第二天0:00会自动解封。 |
10004 | ACCESS_TOO_FREQUENT | 单位时间内访问过于频繁 | 开发者的单位时间内(1分钟)访问量超限,被系统自动封停,下一分钟自动解封。 |
10005 | INVALID_USER_IP | IP白名单出错,发送请求的服务器IP不在IP白名单内 | 开发者在LBS官网控制台设置的IP白名单不正确。白名单中未添加对应服务器的出口IP。可到"控制台>配置" 中设定IP白名单。 |
10006 | INVALID_USER_DOMAIN | 绑定域名无效 | 开发者绑定的域名无效,需要在官网控制台重新设置 |
10007 | INVALID_USER_SIGNATURE | 数字签名未通过验证 | 开发者签名未通过开发者在key控制台中,开启了“数字签名”功能,但没有按照指定算法生成“数字签名”。 |
10008 | INVALID_USER_SCODE | MD5安全码未通过验证 | 需要开发者判定key绑定的SHA1,package是否与sdk包里的一致 |
10009 | USERKEY_PLAT_NOMATCH | 请求key与绑定平台不符 | 请求中使用的key与绑定平台不符,例如:开发者申请的是js api的key,却用来调web服务接口 |
10010 | IP_QUERY_OVER_LIMIT | IP访问超限 | 未设定IP白名单的开发者使用key发起请求,从单个IP向服务器发送的请求次数超出限制,被系统自动封停。封停后无法自动恢复,需要提交工单联系我们。 |
10011 | NOT_SUPPORT_HTTPS | 服务不支持https请求 | 服务不支持https请求,如果需要申请支持,请提交工单联系我们 |
10012 | INSUFFICIENT_PRIVILEGES | 权限不足,服务请求被拒绝 | 由于不具备请求该服务的权限,所以服务被拒绝。 |
10013 | USER_KEY_RECYCLED | Key被删除 | 开发者删除了key,key被删除后无法正常使用 |
10014 | QPS_HAS_EXCEEDED_THE_LIMIT | 云图服务QPS超限 | QPS超出限制,超出部分的请求被拒绝。限流阈值内的请求依旧会正常返回 |
10015 | GATEWAY_TIMEOUT | 受单机QPS限流限制 | 受单机QPS限流限制时出现该问题,建议降低请求的QPS或在控制台提工单联系我们 |
10016 | SERVER_IS_BUSY | 服务器负载过高 | 服务器负载过高,请稍后再试 |
10017 | RESOURCE_UNAVAILABLE | 所请求的资源不可用 | 所请求的资源不可用 |
10019 | CQPS_HAS_EXCEEDED_THE_LIMIT | 使用的某个服务总QPS超限 | QPS超出限制,超出部分的请求被拒绝。限流阈值内的请求依旧会正常返回 |
10020 | CKQPS_HAS_EXCEEDED_THE_LIMIT | 某个Key使用某个服务接口QPS超出限制 | QPS超出限制,超出部分的请求被拒绝。限流阈值内的请求依旧会正常返回 |
10021 | CUQPS_HAS_EXCEEDED_THE_LIMIT | 账号使用某个服务接口QPS超出限制 | QPS超出限制,超出部分的请求被拒绝。限流阈值内的请求依旧会正常返回 |
10026 | INVALID_REQUEST | 账号处于被封禁状态 | 由于违规行为账号被封禁不可用,如有异议请登录控制台提交工单进行申诉 |
10029 | ABROAD_DAILY_QUERY_OVER_LIMIT | 某个Key的QPS超出限制 | QPS超出限制,超出部分的请求被拒绝。限流阈值内的请求依旧会正常返回 |
10041 | NO_EFFECTIVE_INTERFACE | 请求的接口权限过期 | 开发者发起请求时,请求的接口权限过期。请提交工单联系我们 |
10044 | USER_DAILY_QUERY_OVER_LIMIT | 账号维度日调用量超出限制 | 账号维度日调用量超出限制,超出部分的请求被拒绝。限流阈值内的请求依旧会正常返回 |
10045 | USER_ABROAD_DAILY_QUERY_OVER_LIMIT | 账号维度海外服务日调用量超出限制 | 账号维度海外服务接口日调用量超出限制,超出部分的请求被拒绝。限流阈值内的请求依旧会正常返回 |
20000 | INVALID_PARAMS | 请求参数非法 | 请求参数的值没有按照规范要求填写。例如,某参数值域范围为[1,3],开发者误填了’4’ |
20001 | MISSING_REQUIRED_PARAMS | 缺少必填参数 | 缺少接口中要求的必填参数 |
20002 | ILLEGAL_REQUEST | 请求协议非法 | 请求协议非法 比如某接口仅支持get请求,结果用了POST方式 |
20003 | UNKNOWN_ERROR | 其他未知错误 | 其他未知错误 |
300** | ENGINE_RESPONSE_DATA_ERROR | 服务响应失败。 | 出现3开头的错误码,建议先检查传入参数是否正确,若无法解决,请详细描述错误复现信息,提工单给我们。(大数据接口请直接跟负责商务反馈) 如,30001、30002、30003、32000、32001、32002、32003、32200、32201、32202、32203。 |
40000 | QUOTA_PLAN_RUN_OUT | 余额耗尽 | 所购买服务的余额耗尽,无法继续使用服务 |
40002 | SERVICE_EXPIRED | 购买服务到期 | 所购买的服务期限已到,无法继续使用 |
40003 | ABROAD_QUOTA_PLAN_RUN_OUT | 海外服务余额耗尽 | 所购买服务的海外余额耗尽,无法继续使用服务 |
业务类异常码大类
code | message | 状态描述 | 问题排查策略 |
10xxxx | 通用业务系统异常码 | ||
11xxxx | 企业内组织异常码 | 参考 | |
12xxxx | 企业内工作地图异常码 | ||
13xxxx | 开放生态数据同步异常码 |
业务类异常码对照表
通用业务系统异常码
code | message | 状态描述 | 问题排查策略 |
0 | Unexpected error | 未知错误 | |
1 | Successful | 请求成功 | |
2 | Failure | 请求失败 | |
3 | Param error | 参数错误 | |
4 | sentinel block | 限流 |
code | message | 状态描述 | 问题排查策略 |
100010 | biz sign error | 业务签名错误 | 按照业务签名算法进行签名 |
100011 | token not register | token未注册 | |
100012 | passport用户信息查询失败 | passport用户信息查询失败 | |
100013 | 不合法的aes key | 不合法的aes key | |
100014 | 计算加密字符错误 | 计算加密字符错误 | |
100015 | 计算解密字符错误 | 计算解密字符错误 | |
100016 | 计算解密字符长度不匹配 | 计算解密字符长度不匹配 | |
100017 | openId和bizToken不匹配 | openId和bizToken不匹配 |
企业组织相关
code | message | 状态描述 | 问题排查策略 |
110001 | 用户不在组织内 | 用户不在组织内 | 需要先将用户加入到组织中 |
110002 | 组织不存在 | 组织不存在 | 组织不存在,组织可能已经失效了 |
110003 | 企业名称违规 | 企业名称违规 | 企业名称违规,建议更换 |
110004 | 用户无权限 | 用户无权限 | 建议排查用户角色 |
110005 | 企业员工数量已达上限 | 企业员工数量已达上限 | 企业员工数量已达上限 |
110006 | 员工昵称违规 | 员工昵称违规 | 员工昵称违规 |
110007 | 企业名称长度超限 | 企业名称长度超限 | 企业名称长度超限 |
企业部门相关
code | message | 状态描述 | 问题排查策略 |
110101 | 部门无效 | 确认部门ID是个有效的参数 | |
110102 | 部门级别达到最大值 | 部门级别最大支持20级 | |
110103 | 部门名称重复 | 同一企业下的部门名称不允许重复 | |
110104 | 直接子部门个数已达最大值 | 一个部门下最多创建1000个直接子部门 | 建议排查用户角色 |
110105 | 部门名称违规 | ||
110106 | 部门描述违规 | ||
110107 | 删除的部门下还有子部门 | 被删除的部门下还有子部门时不允许删除 | |
110108 | 删除的部门下还有员工 | 被删除的部门下还有员工时不允许删除 | |
110109 | 批量移动员工时,员工个数已达上限 | 批量操作的批大小超出限制 | |
110110 | 设置员工部门时,部门个数达到上限 |
地图相关
code | message | 状态描述 | 问题排查策略 |
120001 | 组织下地图数量已达上限 | 组织下地图数量已达上限 | 组织下地图数量已达上限 |
120002 | 用户下地图数量已达上限 | 用户下地图数量已达上限 | 用户下地图数量已达上限 |
120003 | 地图不存在 | 地图不存在 | 地图不存在 |
120004 | 地图名称违规 | 地图名称违规 | 地图名称违规 |
120005 | 地图人数超过上限 | 地图人数超过上限 | 地图人数超过上限 |
120006 | 加入地图已提交申请 | 加入地图已提交申请 | 建议从高德app内关掉加入审批功能,关闭后重新加入即可 |
120007 | 地图名称长度不符合要求 | 地图名称长度不符合要求 | 地图名称长度不符合要求 |
开放生态数据同步
code | message | 状态描述 | 问题排查策略 |
130001 | 批量操作数据量超出限制 | 批量操作数据量超出限制 | |
130002 | 文件夹数据量超出限制 | 文件夹数据量超出限制 | |
130003 | 定义的资源状态据量超出限制 | 定义的资源状态据量超出限制 | |
130004 | 存在重复的资源状态定义 | 存在重复的资源状态定义 | |
130005 | 存在重复的资源数据 | 存在重复的资源数据 | |
130006 | 存在重复的文件夹数据 | 存在重复的文件夹数据 |