查询流量池概览
接口描述
查询当前 AccessKey 所属公司的流量池概览,包括当月总额度、已用量、独占预留、共享池剩余,以及月固定套餐与加油包的份数、单价、每份额度等信息。
公司未开通流量池时,接口正常返回,但所有字段为 0 / 空串(用于前端渲染空态)。
请求说明
| 接口ID | 协议 | 方法 | PATH |
|---|---|---|---|
| 87 | HTTPS | GET | /openapi/v1/pbs/sim_data_pool/summary |
PATH参数
无
URL参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| accesskey_id | string | 是 | 参见签名认证 |
| expires | int | 是 | 参见签名认证 |
| signature | string | 是 | 参见签名认证 |
请求示例
GET https://open.vzicloud.com/openapi/v1/pbs/sim_data_pool/summary?accesskey_id=8d9EsDAD2115Q5PM8tuP6g1IdAglkayp&expires=1619022787&signature=G29eTBjMm0gZF7cpXNLX7Hrn0yM%3D HTTP/1.1
返回说明
返回参数
| 参数 | 类型 | 说明 |
|---|---|---|
| total_volume_kb | int | 当月池总额度(月固定部分 + 加油包累计) |
| used_volume_kb | int | 当月已消耗流量 |
| reserved_volume_kb | int | 所有「独占预留」分组预留额度之和 |
| shared_available_kb | int | 共享池实时剩余 = 总额度 − 独占预留 − (已用 − 各独占组已用),负值按 0 |
| month_fixed_count | int | 当前月固定套餐份数 |
| month_fixed_package_code | string | 月固定套餐编码(运营未配置时为空串) |
| month_fixed_unit_price | int | 月固定套餐每份单价(单位:分) |
| month_fixed_package_volume_kb | int | 月固定套餐每份额度(KB) |
| month_fixed_volume_kb | int | 月固定部分总额 = 份数 × 每份额度 |
| addon_package_code | string | 加油包套餐编码(未配置为空串) |
| addon_unit_price | int | 加油包每份单价(单位:分) |
| addon_package_volume_kb | int | 加油包每份额度(KB) |
| addon_volume_kb | int | 加油包部分总额(当月有效加油包额度之和) |
| period | string | 当月账期,格式 YYYY-MM |
注:流量字段单位为 KB,金额字段单位为分。
返回示例
{
"total_volume_kb": 12582912,
"used_volume_kb": 3145728,
"reserved_volume_kb": 0,
"shared_available_kb": 9437184,
"month_fixed_count": 10,
"month_fixed_package_code": "pc_sim_data_pool_monthly_1gb",
"month_fixed_unit_price": 1000,
"month_fixed_package_volume_kb": 1048576,
"month_fixed_volume_kb": 10485760,
"addon_package_code": "pc_sim_data_pool_addon_1gb",
"addon_unit_price": 1200,
"addon_package_volume_kb": 1048576,
"addon_volume_kb": 2097152,
"period": "2026-08"
}