遍历流量池设备

接口描述

遍历当前 AccessKey 所属公司的全部 4G 流量设备（带 SIM 卡的设备），支持分页与条件查询。返回每台设备的当月用量、SIM 卡状态及所属流量池分组。典型用法是按 pool_group_id 筛选某分组下的设备，或按 sn/iccid 定位特定设备。

请求说明

接口ID 协议 方法 PATH
88 HTTPS GET /openapi/v1/pbs/sim_data_pool/devices

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：

参数 类型 说明
sn string 设备SN
iccid string SIM 卡 ICCID
sim_status int SIM 卡状态（2=正常 3=已停机 100=已废弃）
pool_group_id int 所属流量池分组ID（eq 0 查未入组设备、eq N 查指定分组、gt 0 查已入组）

请求示例

GET https://open.vzicloud.com/openapi/v1/pbs/sim_data_pool/devices?page=1&size=10&wheres=W3siayI6InBvb2xfZ3JvdXBfaWQiLCJvIjoiZXEiLCJ2IjoxMDJ9XQ==&accesskey_id=8d9EsDAD2115Q5PM8tuP6g1IdAglkayp&expires=1619022787&signature=G29eTBjMm0gZF7cpXNLX7Hrn0yM%3D HTTP/1.1

上例 wheres 解码后为 [{"k":"pool_group_id","o":"eq","v":102}]（查询分组 102 下的设备）。

返回说明

返回参数

参数 类型 说明
total int 符合条件的设备总数
page int 当前页码
size int 当前页大小
items list 设备列表
+ sn string 设备SN
+ device_name string 设备名称（来自 stp_device.name）
+ iccid string SIM 卡 ICCID
+ state int 设备在线状态（0=在线 1=离线，来自 stp_device.state）
+ sim_status int SIM 卡状态（2=正常 3=已停机 100=已废弃）
+ pool_group_id int 所属流量池分组ID（未加入分组时为 0）
+ pool_group_name string 所属流量池分组名称（未加入时为空）
+ this_month_total_data_usage int 当月已用流量总量（KB）
+ this_month_max_data_volume int 当月最大额度（KB）。= 赠送 + 智能补充 + 固定流量 + 流量池上限
+ this_month_pool_data_usage int 当月消耗的流量池额度（KB）
+ this_month_purchased_volume int 当月已购额度合计（免费+智能补充+固定流量，KB）
+ this_month_free_data_volume int 当月免费额度（KB）
+ this_month_free_data_usage int 当月免费额度已用（KB）
+ this_month_paid_data_volume int 当月智能补充额度（KB，不含固定流量）
+ this_month_paid_data_usage int 当月智能补充额度已用（KB）
+ perm_data_volume int 固定流量总额度（KB）。全部永久包累计，跨月累积不清零（非月度统计），无永久包时为 0
+ perm_data_usage int 固定流量已用（KB）
+ remaining_kb int 剩余流量 = 最大额度 − 已用，负值按 0（KB）

单位约定：所有流量字段单位为 KB。 口径说明：this_month_* 为当月统计（月初随套餐周期重算）；perm_data_* 为累计值（永久包无使用期限、跨月累积），二者含义不同勿混用。

返回示例

{
  "total": 1,
  "page": 1,
  "size": 10,
  "items": [
    {
      "sn": "12345678-87654321",
      "device_name": "出入口相机-东门",
      "iccid": "89860412345678901234",
      "state": 0,
      "sim_status": 2,
      "pool_group_id": 102,
      "pool_group_name": "出入口设备",
      "this_month_total_data_usage": 524288,
      "this_month_max_data_volume": 1572864,
      "this_month_pool_data_usage": 524288,
      "this_month_purchased_volume": 1048576,
      "this_month_free_data_volume": 524288,
      "this_month_free_data_usage": 524288,
      "this_month_paid_data_volume": 524288,
      "this_month_paid_data_usage": 0,
      "perm_data_volume": 0,
      "perm_data_usage": 0,
      "remaining_kb": 1048576
    }
  ]
}

results matching ""

    No results matching ""