查询设备流量池信息

接口描述

根据设备序列号查询该设备的流量池归属与当月用量，包括所属分组的限额配置、组已用量，以及设备当月用量全集与剩余流量。

设备未加入任何分组时，pool_group_id 返回 0、pool_group_name 返回空串；分组属性字段（group_mode、is_default、total_quota_kb、per_device_quota_kb、group_used_volume_kb）因查不到所属分组而返回 null。

请求说明

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

PATH参数

参数 类型 必填 说明
sn string 是 PATH中的:sn需要替换为具体的设备序列号（格式：8位十六进制-8位十六进制，或 20 位数字）

URL参数

参数 类型 必填 说明
accesskey_id string 是 参见签名认证
expires int 是 参见签名认证
signature string 是 参见签名认证

请求示例

GET https://open.vzicloud.com/openapi/v1/pbs/sim_data_pool/devices/12345678-87654321?accesskey_id=8d9EsDAD2115Q5PM8tuP6g1IdAglkayp&expires=1619022787&signature=G29eTBjMm0gZF7cpXNLX7Hrn0yM%3D HTTP/1.1

返回说明

返回参数

参数 类型 说明
sn string 设备SN
device_name string 设备名称
state int 设备在线状态（0=在线 1=离线）
iccid string SIM 卡 ICCID
sim_status int SIM 卡状态（2=正常 3=已停机 100=已废弃，其余值见下表）
pool_group_id int 所属分组ID，未加入分组时为 0
pool_group_name string 所属分组名称，未加入分组时为空串
group_mode int 所属分组限额模式（0=共享 1=独占预留），未加入分组时为 null
is_default int 所在分组是否默认分组（1=是 0=否），未加入分组时为 null
total_quota_kb int 所在组总额度（0=不限），未加入分组时为 null
per_device_quota_kb int 所在组单设备额度（0=不限），未加入分组时为 null
group_used_volume_kb int 所在组当月已消耗，未加入分组时为 null
this_month_total_data_usage int 设备当月已用流量
this_month_max_data_volume int 设备当月最大额度（免费 + 智能补充 + 固定流量 + 可用池额度）
this_month_pool_data_usage int 设备当月消耗的流量池额度
this_month_purchased_volume int 设备当月已购额度（免费 + 智能补充 + 固定流量）
perm_data_volume int 固定流量总额度（KB）。全部永久包累计，跨月累积不清零（非当月统计），无永久包时为 0
perm_data_usage int 固定流量已用（KB）
remaining_kb int 剩余流量 = 最大额度 − 已用，负值按 0

口径说明：this_month_* 为当月统计；perm_data_* 为累计值（永久包无使用期限），勿混用。

sim_status 枚举：

值 含义
2 已激活（正常）
3 已停用（停机）
100 已废弃（无效卡，不参与流量处理）

返回示例

设备已加入分组：

{
  "sn": "12345678-87654321",
  "device_name": "出入口相机-东门",
  "state": 0,
  "iccid": "89860412345678901234",
  "sim_status": 2,
  "pool_group_id": 102,
  "pool_group_name": "出入口设备",
  "group_mode": 1,
  "is_default": 0,
  "total_quota_kb": 3145728,
  "per_device_quota_kb": 1048576,
  "group_used_volume_kb": 2097152,
  "this_month_total_data_usage": 524288,
  "this_month_max_data_volume": 1572864,
  "this_month_pool_data_usage": 524288,
  "this_month_purchased_volume": 1048576,
  "perm_data_volume": 0,
  "perm_data_usage": 0,
  "remaining_kb": 1048576
}

设备未加入分组（pool_group_id 为 0、group_* 为 null）：

{
  "sn": "12345678-87654322",
  "device_name": "停车场入口",
  "state": 1,
  "iccid": "89860412345678905678",
  "sim_status": 2,
  "pool_group_id": 0,
  "pool_group_name": "",
  "group_mode": null,
  "is_default": null,
  "total_quota_kb": null,
  "per_device_quota_kb": null,
  "group_used_volume_kb": null,
  "this_month_total_data_usage": 204800,
  "this_month_max_data_volume": 1048576,
  "this_month_pool_data_usage": 0,
  "this_month_purchased_volume": 1048576,
  "perm_data_volume": 0,
  "perm_data_usage": 0,
  "remaining_kb": 843776
}

错误码

HTTP 状态 code 说明
400 1005 设备未找到（该 SN 在系统中无 4G 流量设备记录）

results matching ""

    No results matching ""