遍历流量池分组
接口描述
遍历当前 AccessKey 所属公司的全部分组(含系统自动创建的默认分组),支持分页与条件查询。返回每个分组的限额配置、当月已用量及组内设备数。
请求说明
| 接口ID | 协议 | 方法 | PATH |
|---|---|---|---|
| 85 | HTTPS | GET | /openapi/v1/pbs/sim_data_pool/groups |
PATH参数
无
URL参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| page | int | 否 | 页码,最小 1,默认 1 |
| size | int | 否 | 分页大小,最大 10000,默认 10000 |
| wheres | string | 否 | 参见WHERES参数 |
| orders | string | 否 | 排序条件,base64 编码的 JSON 数组,每个元素 {k, o},o 为 ASC/DESC |
| accesskey_id | string | 是 | 参见签名认证 |
| expires | int | 是 | 参见签名认证 |
| signature | string | 是 | 参见签名认证 |
wheres允许填入的k:
| 参数 | 类型 | 说明 |
|---|---|---|
| name | string | 分组名称 |
| mode | int | 限额模式(0=共享 1=独占预留) |
| is_default | int | 是否默认分组(1=是 0=否) |
| spillover | int | 独占预留子模式(0=硬上限 1=保底溢出),共享组忽略 |
| id | int | 分组ID |
请求示例
GET https://open.vzicloud.com/openapi/v1/pbs/sim_data_pool/groups?page=1&size=10&wheres=W3siazI6Im5hbWUiLCJvIjoibGlrZSIsInYiOiIl5Ye654S244CB5a6k6IeSJ31D&accesskey_id=8d9EsDAD2115Q5PM8tuP6g1IdAglkayp&expires=1619022787&signature=G29eTBjMm0gZF7cpXNLX7Hrn0yM%3D HTTP/1.1
上例
wheres解码后为[{"k":"name","o":"like","v":"%出入口设备%"}](按分组名称模糊匹配)。
返回说明
返回参数
| 参数 | 类型 | 说明 |
|---|---|---|
| total | int | 符合条件的分组总数 |
| page | int | 当前页码 |
| size | int | 当前页大小 |
| items | list | 分组列表 |
| + id | int | 分组ID |
| + name | string | 分组名称 |
| + mode | int | 限额模式(0=共享 1=独占预留) |
| + spillover | int | 独占预留子模式(0=硬上限 1=保底溢出),共享组忽略此字段 |
| + total_quota_kb | int | 组总额度(0=不限流量) |
| + per_device_quota_kb | int | 组内单设备额度(0=不限) |
| + used_volume_kb | int | 组当月已消耗流量 |
| + is_default | int | 是否为默认分组(1=是 0=否),默认分组不可删除 |
| + device_count | int | 组内设备数 |
| + create_time | string | 创建时间 |
| + update_time | string | 更新时间 |
返回示例
{
"total": 2,
"page": 1,
"size": 10,
"items": [
{
"id": 101,
"name": "默认分组",
"mode": 0,
"spillover": 0,
"total_quota_kb": 0,
"per_device_quota_kb": 0,
"used_volume_kb": 1048576,
"is_default": 1,
"device_count": 5,
"create_time": "2026-07-27 10:00:00.000000",
"update_time": "2026-08-01 03:00:00.000000"
},
{
"id": 102,
"name": "出入口设备",
"mode": 1,
"spillover": 1,
"total_quota_kb": 3145728,
"per_device_quota_kb": 1048576,
"used_volume_kb": 2097152,
"is_default": 0,
"device_count": 3,
"create_time": "2026-07-28 09:30:00.000000",
"update_time": "2026-08-02 14:15:00.000000"
}
]
}