外观
API Client / Scope 错误码(106*)
段位:106001 - 106009;共 9 个;全部 V1 暴露
通用约定(HTTP status /
code=1兜底 / 响应结构)见 README
106001 CLIENT_NOT_FOUND
- HTTP status:200
- 含义:API Client 不存在
- 典型触发条件:管理动作(查询 / 更新 / 删除某 API Client)引用了不存在的 clientId
- 处理建议:核对 clientId;clientId 在租户内唯一
- 示例响应:
json
{ "code": 106001, "msg": "API Client 不存在", "data": null }106002 CLIENT_DATA_ERROR
- HTTP status:200
- 含义:API Client 数据转换失败
- 典型触发条件:atkonbase 内部数据状态异常——集成方正常调用不会触发,通常属服务端内部错误
- 处理建议:携带响应中的
rid/X-Request-Id联系 ATKONBASE 支持团队;集成方无法自助处理 - 示例响应:
json
{ "code": 106002, "msg": "API Client 数据转换失败", "data": null }106003 CLIENT_INVALID_STATUS
- HTTP status:200
- 含义:无效的客户端状态
- 典型触发条件:尝试将 API Client 状态置为非法值,或在不允许的状态下执行操作
- 处理建议:API Client 状态机受控;详见 Console「API 客户端」管理页面的状态流转图
- 示例响应:
json
{ "code": 106003, "msg": "无效的客户端状态", "data": null }106004 SCOPE_NOT_FOUND
- HTTP status:200
- 含义:Scope 不存在
- 典型触发条件:引用了不存在的 scopeCode
- 处理建议:核对 scopeCode;可用 Scope 清单在 Console「Scope」管理页面查看
- 示例响应:
json
{ "code": 106004, "msg": "Scope 不存在", "data": null }106005 SCOPE_CODE_INVALID
- HTTP status:200
- 含义:scopeCode 格式无效
- 典型触发条件:创建 Scope 时 scopeCode 不符合命名规范(如包含非法字符)
- 处理建议:scopeCode 推荐命名形如
client:storage:document:read—— 冒号分段、全小写、字母数字与下划线 - 示例响应:
json
{ "code": 106005, "msg": "scopeCode 格式无效", "data": null }106006 SCOPE_IN_USE
- HTTP status:200
- 含义:Scope 已被使用
- 典型触发条件:试图删除被 API Client 引用的 Scope
- 处理建议:先在 Console 解除所有 API Client 对该 Scope 的引用,再删除 Scope
- 示例响应:
json
{ "code": 106006, "msg": "Scope 已被使用", "data": null }106007 SCOPE_ALREADY_EXISTS
- HTTP status:200
- 含义:scopeCode 已存在
- 典型触发条件:创建 Scope 时使用了已被占用的 scopeCode
- 处理建议:换用唯一的 scopeCode;scopeCode 在租户内唯一
- 示例响应:
json
{ "code": 106007, "msg": "scopeCode 已存在", "data": null }106008 CLIENT_SCOPE_MISSING
- HTTP status:200
- 含义:API Client 未配置 Scope
- 典型触发条件:API Client 在颁发 token 时校验发现其 Scope 列表为空
- 处理建议:联系租户管理员在 Console 给该 API Client 配置至少一个 Scope
- 示例响应:
json
{ "code": 106008, "msg": "API Client 未配置 Scope", "data": null }106009 CLIENT_SCOPE_INSUFFICIENT
- HTTP status:200
- 含义:API Client Scope 不包含此权限
- 典型触发条件:与 102002(SCOPE_DENIED)相似但侧重 Client 级——API Client 的 Scope 范围不覆盖目标端点要求
- 处理建议:联系租户管理员在 Console 增配缺失的 Scope;106009 在校验 API Client 自身 Scope 时返回,102002 在访问具体端点时返回;集成方处理方式一致:补齐缺失 Scope
- 示例响应:
json
{ "code": 106009, "msg": "API Client Scope 不包含此权限", "data": null }