流量池
功能简介
流量池是面向 4G 流量设备(带 SIM 卡、走 4G 蜂窝网络联网的视频监控设备)的公司级共享流量额度能力。公司开通流量池后,可获得一份按月订阅的共享流量额度(月固定套餐),池内所有设备共同消耗这份额度,避免单台设备流量跑超停机;额度不够时还可临时购买加油包。
平台以「分组」组织池内设备:每台设备归属于一个分组,分组可配置总额度与单设备额度双重限额,支持两种限额模式(共享 / 独占预留)。公司开通流量池时系统会自动创建一个默认分组(不限流量)。
流量池是单设备流量套餐方案的补充:设备加入分组后走流量池额度;移出分组则回到单设备套餐方案。两种方案共存,互不影响。
前提条件
- 公司需已开通流量池。未开通时,查询流量池概览 返回全 0 的空对象,设备加入/移出分组接口会返回「公司未开启流量池」错误。开通流程请联系运营。
- 设备需为 4G 流量设备(设备表登记了 SIM 卡 ICCID)。普通有线设备不适用。
关键概念
| 概念 | 说明 |
|---|---|
| 月固定套餐 | 按月订阅的池额度,每月初自动续发并扣费;可随时调整份数(升级/降级,降级次月生效) |
| 加油包 | 临时购买的额外额度,当月有效,买了不退 |
| 分组(group) | 池内设备的逻辑编组,配置总额度与单设备额度;设备加入分组后才消耗池额度 |
| 共享组(mode=0) | 组内设备共用池额度,受「单设备额度」与「组总额度」约束 |
| 独占预留组(mode=1) | 为本组预留固定额度(独占),不与其他组共享;可选「保底溢出」(spillover=1,预留用尽后回退抢共享池)或「硬上限」(spillover=0,用尽即停) |
| 默认分组 | 公司开通流量池时系统自动创建的不限流量分组(is_default=1),不可删除 |
单位约定:所有流量字段单位为 KB,所有金额字段单位为 分。
鉴权约定:本分类所有接口的操作对象均为 AccessKey 所属公司(由鉴权自动注入 company_id),无需也无法指定其他公司,避免越权。
接口列表
| 接口 | 方法 | PATH |
|---|---|---|
| 查询流量池概览 | GET | /openapi/v1/pbs/sim_data_pool/summary |
| 遍历流量池分组 | GET | /openapi/v1/pbs/sim_data_pool/groups |
| 遍历流量池设备 | GET | /openapi/v1/pbs/sim_data_pool/devices |
| 查询设备流量池信息 | GET | /openapi/v1/pbs/sim_data_pool/devices/:sn |
| 批量设备加入流量池分组 | POST | /openapi/v1/pbs/sim_data_pool/groups/:id/devices |
| 批量设备移出流量池分组 | DELETE | /openapi/v1/pbs/sim_data_pool/groups/:id/devices |