状态码总览
客户端应先判断 HTTP 状态码,再读取响应体中的 code。
成功类响应
| HTTP 状态码 | 业务码 | 说明 |
|---|---|---|
| 200 | SUCCESS | 请求成功并返回结果 |
| 202 | COMMAND_ACCEPTED | 命令已被接受,设备执行结果需查询命令状态 |
错误类响应
| HTTP 状态码 | 业务码 | 说明 |
|---|---|---|
| 400 | INVALID_REQUEST | 请求参数、请求体或请求头不合法 |
| 401 | AUTH_REQUIRED | 缺少 Authorization 请求头 |
| 401 | AUTH_INVALID | 认证信息无效 |
| 401 | AUTH_EXPIRED | access token 已过期 |
| 403 | AUTH_SCOPE_DENIED | 当前客户端没有访问该接口所需权限 |
| 404 | DEVICE_NOT_FOUND | 设备不存在,或当前客户端无权访问该设备 |
| 404 | COMMAND_NOT_FOUND | 命令不存在,或当前客户端无权访问该命令 |
| 409 | IDEMPOTENCY_CONFLICT | 同一个 Idempotency-Key 被用于不同请求体 |
| 422 | COMMAND_REJECTED | 命令格式合法,但业务上被拒绝 |
| 429 | RATE_LIMITED | 请求触发限流 |
| 500 | INTERNAL_ERROR | OpenAPI 服务处理失败 |
