附录 B 状态与枚举字典
界面上的状态文案优先取自「字典管理」中的字典项(见 21.4),本附录列的是出厂兜底值与码值含义。现场若改过字典名,以界面实际显示为准。 码值(如
active、1)是系统内部契约,只用于对照日志与接口返回,不要据此改字典值。
B.1 通用状态
| 场景 | 码值 | 展示 | 说明 |
|---|---|---|---|
| 账号 / 角色 / 部门 / 字典 / 字典值 状态 | 1 | 启用 | 正常可用 |
0 | 禁用 | 立即失去作用(角色禁用=其权限失效;账号禁用=不能登录) |
B.2 设备与通道
| 场景 | 码值 | 展示 |
|---|---|---|
设备 / 通道在线状态(字典 device_status) | online / true / 1 | 在线 |
offline / false / 0 | 离线 |
平台在不同接口里把在线状态给出三种形状(布尔、数字、字符串),界面统一归一化成「在线 / 离线」。取不到值时按各页面自己的口径显示为空或「-」,不会擅自当成在线。
B.3 播放与录像
| 场景 | 取值 | 说明 |
|---|---|---|
| 播放协议 | 见 5.4 节的协议清单 | 界面按协议族分组,切换遵循第 5 章的约束 |
| 录像缓存任务 | 排队、执行中、合并中、成功、失败、已取消 | 「合并中」仍算活动任务但不可停止;成功任务才可下载 |
| 录像计划执行状态 | 已生效、未生效、失败 | 见 9.6、9.7 节 |
B.4 告警
告警级别与处理状态的取值由「字典管理」中的告警相关字典决定,界面按级别配色(见 11.4 节)。不要在字典里新增级别码值——级别是告警联动与通知的分支依据。
B.5 日志
| 场景 | 说明 |
|---|---|
| 运行日志级别 | 按级别筛选与着色,取值见第 19 章「运行日志」 |
| SIP 日志方向 | 接收 / 发送 |
| 登录日志结果 | 成功 / 失败(失败含原因,可解锁) |
B.6 国标级联
| 场景 | 取值 | 说明 |
|---|---|---|
| 上级平台注册状态 | 在线、离线、注册失败 | 见 13.5 节 |
| 传输协议 | UDP、TCP | 与上级约定一致 |
B.7 OpenAPI
| 场景 | 码值 | 展示 |
|---|---|---|
| 客户端认证状态 | active | 启用(绿) |
disabled | 停用(橙) | |
revoked | 已撤销(红) | |
| 客户端数据范围 | 3 | 本部门 |
4 | 本部门及以下 | |
| 能力风险等级 | read | 只读(绿) |
media | 媒体(橙) | |
control | 控制(红) | |
destructive | 破坏性(红) | |
| 其他值 | 风险未知(灰) | |
| 调用结果 | success | 成功(绿) |
| 其他值 | 失败(橙) | |
| 幂等策略 | required | 要求 Idempotency-Key |
optional | 支持 Idempotency-Key | |
none | 不涉及幂等 |
B.8 系统管理
| 场景 | 码值 | 展示 |
|---|---|---|
| 菜单类型 | 1 | 目录(紫) |
2 | 菜单(绿) | |
3 | 按钮(灰) | |
| 角色数据权限范围 | 1 | 全部 |
2 | 自定义 | |
3 | 本部门 | |
4 | 本部门及子级 | |
| 定时任务执行策略 | 0 | 单次执行 |
1 | 重复执行 | |
| 定时任务阻塞策略 | 0 | 丢弃 |
1 | 并行 | |
| 定时任务状态 | 1 / 0 | 启用 / 禁用 |
| 服务升级通道 | stable | 稳定版 |
beta | 预发布版 |
B.9 升级任务阶段
「升级记录」的「阶段 / 结果」列与「任务详情」里的「失败阶段」用同一套取值:
| 码值 | 展示 | 所属步骤 |
|---|---|---|
fetching | 下载中 | 准备与授权 |
verifying | 校验中 | 准备与授权 |
preparing | 准备与预检 | 准备与授权 |
awaiting_confirmation | 等待应用授权 | 准备与授权 |
stopping | 停止服务 | 准备与授权 |
backing_up | 备份数据 | 备份数据 |
migrating | 执行迁移 | 执行迁移 |
activating | 切换版本 | 切换与验证 |
validating | 验证启动 | 切换与验证 |
committing | 提交升级结果 | 切换与验证 |
succeeded | 升级成功 | 完成 |
failed | 任务失败或已取消 | — |
rolled_back | 已恢复旧版本 | — |
recovery_required | 需要恢复处理 | — |
进度条把上述阶段归并成五步:准备与授权 → 备份数据 → 执行迁移 → 切换与验证 → 完成。出现
recovery_required必须人工介入,不能重试了事。