错误码
响应格式
hapi / mapi
HTTP 200
{ "code": 0, "message": "成功", "data": ... }hapi/mapi 的业务错误和服务器错误均返回 HTTP 200,通过 code 字段区分(0 = 成功,非 0 = 错误)。
ztmp
ztmp 区分 HTTP 状态码:
成功:
HTTP 200
[ ... ] // gateway 批量结果数组业务错误(BizError):
HTTP 4xx
{ "code": "ERROR_KEY", "message": "中文错误描述" }服务器错误:
HTTP 500
{ "code": "SERVER_ERROR", "message": "..." }ztmp 错误码
与 hapi 共用的错误码
| 键名 (code) | HTTP Status | 说明 |
|---|---|---|
VALIDATE_ERROR | 400 | 参数错误 / 参数缺失 / 参数不匹配 |
USER_AUTH_FAILED | 401 | 未登录 / Token 过期 / Token 无效 |
MOBILE_OR_PWD_ERROR | 401 | 手机号或密码错误 / 旧密码错误 |
USER_NOT_FOUND | 401 | 用户不存在 / 找不到会员 |
NO_PERMISSION | 403 | 账号类型不符,无权操作 |
DEVICE_NOT_FOUND | 404 | 设备/网关不存在 |
DEVICE_BEEN_BOUND | 409 | 设备/网关已被其他账号绑定 |
HTTP_NOT_FOUND | 404 | 服务不存在 |
SERVER_ERROR | 500 | 服务器异常 / 配置错误 / 编号生成失败 |
SERVICE_UNAVAILABLE | 500 | Redis 服务不可用 |
ztmp 独有的错误码
| 键名 (code) | HTTP Status | 说明 |
|---|---|---|
RECORD_NOT_FOUND | 404 | 无法找到对应的记录 |
PROJECT_NOT_FOUND | 404 | 项目不存在或无权操作 |
INVITATION_EXPIRED | 404 | 该家庭已被接收,或者二维码已失效 |
TRANSFER_REJECTED | 409 | 家庭移交已被拒绝 |
TRANSFER_SELF | 400 | 不能将家庭移交给自己 |
DEVICE_SN_MISSING | 400 | 该设备未获取到网关 SN |
PROJECT_KEY_MISSING | 400 | 项目未获取到 private_key |
CODE_DUPLICATE | 409 | 编号已存在 |
ROLE_NOT_CONFIGURED | 500 | 未配置对应的角色,请联系管理员 |
注意:
GATEWAY_BEEN_BOUND作为DEVICE_BEEN_BOUND的 message 文本保留,用于前端兼容判断。
hapi 错误码
| 错误码 | 键名 | 说明 |
|---|---|---|
| 0 | SUCCESS | 成功 |
| 10000 | UNKNOWN | 未知错误 |
| 10403 | HTTP_FORBIDDEN | 拒绝访问 |
| 10404 | HTTP_NOT_FOUND | 接口未找到 |
| 10500 | SERVER_ERROR | 服务器异常 |
| 11001 | VALIDATE_ERROR | 参数错误 |
| 11400 | NO_PERMISSION | 没有权限 |
| 21001 | MOBILE_OR_PWD_ERROR | 手机号码或密码错误 |
| 21003 | USER_AUTH_FAILED | 用户认证失败 |
| 21004 | USER_NOT_FOUND | 未找到此用户 |
| 21007 | OLD_PASSWORD_ERROR | 旧密码错误 |
| 31001 | LACK_OF_HEADERS | 缺少 headers 信息 |
| 31002 | DEVICE_AUTH_FAILED / MODULE_AUTH_FAILED | 设备认证失败 |
| 31003 | TIMESTAMP_INVALID | 无效的时间戳 |
| 32001 | MODEL_NOT_FOUND | 未找到设备型号 |
| 33001 | LICENSE_NOT_FOUND | 未找到设备 license |
| 34001 | DEVICE_NOT_FOUND | 未找到此设备 |
| 34002 | DEVICE_BEEN_BOUND | 设备被其他人绑定 |
| 51004 | HOTEL_NOT_FOUND | 酒店不存在 |
| 71001 | ROOM_NOT_FOUND | 没找到这个房间 |
| 72005 | CLIENT_TOKEN_EXPIRED | 控制码已失效 |
| 91001 | OPEN_API_VALIDATE_ERROR | 认证错误 |
| 91002 | OPEN_API_TIMESTAMP_ERROR | 时间无效 |
| 91003 | OPEN_API_SIGNATURE_ERROR | 签名错误 |
mapi 认证
| result | 说明 |
|---|---|
allow | 允许 MQTT 连接 |
deny | 拒绝 MQTT 连接(mq_pass 不匹配或 status≠1) |
