获取设备列表
接口功能
分页获取项目下设备列表。
请求地址
https://open.qly.cmviot.cn/v3/open/api/device/list请求方式
POST,需要鉴权
请求参数
| 参数名称 | 参数类型 | 是否必需 | 参数含义 | 说明 |
|---|---|---|---|---|
| page | int | N | 页码 | |
| pageSize | int | N | 每页大小,最大为 100 | |
| onlineStatus | int | N | 设备在线状态 | 1:在线;0:离线) ,非必填,不传则返回所有设备 |
请求示例
{
"page": 1,
"pageSize": 10
}响应参数
| 参数名称 | 参数类型 | 参数含义 | 说明 |
|---|---|---|---|
| resultCode | String | 响应码 | 参考响应码定义 |
| resultMsg | String | 响应描述 | |
| total | Integer | 记录数 | 分页查询时使用 |
| page | Integer | 当前页 | 分页查询时使用 |
| pageSize | Integer | 页大小 | 分页查询时使用,最大为 100 |
| data | List | 响应数据 | 响应数据,支持分页和不分页两种方式 |
data 数据模型
| 名称 | 类型 | 是否必须 | 说明 | 备注 |
|---|---|---|---|---|
| deviceId | String | Y | 摄像机 MAC | 如 xxxxS_2418c624d26b, gb_45671234561324556789 |
| deviceName | String | Y | 摄像机名称 | |
| createTime | String | Y | 创建时间 | 13 位时间戳 |
| camModelName | String | Y | 摄像机型号名称 | |
| deviceStatus | int | Y | 摄像机在线状态 1:在线;0:离线;2: 国标设备未接入 | |
| deviceSwitch | int | Y | 摄像机开关状态 1:打开;0:关闭;2:未知状态 | |
| deviceLatitude | String | N | 设备位置纬度 | |
| deviceLongitude | String | N | 设备位置经度 | |
| nvrInfo | object | N | 本设备所属的 NVR 设备信息。非 NVR 下的通道设备,不会返回该参数 | |
| deviceType | String | N | 设备类型 | 设备类型:IPC、NVR |
| deviceProtocol | String | N | 设备协议 | 设备协议:千里眼协议、国标协议 |
| deviceAddress | String | N | 设备所在位置 |
nvrInfo
| 名称 | 类型 | 说明 | 备注 |
|---|---|---|---|
| deviceId | String | NVR 设备通道编码 | |
| deviceName | String | NVR 通道名称 |
响应示例
{
"resultCode": "000000",
"resultMsg": "成功",
"data": [
{
"deviceId": "gb_67793971881318000003",
"deviceName": "nvrsheb95",
"createTime": 1721902314000,
"camModelName": "GB",
"deviceStatus": 2,
"deviceSwitch": 1,
"deviceLatitude": "",
"deviceLongitude": "",
"deviceType": "nvr",
"deviceProtocol": "国标协议",
"nvrInfo": {
"deviceId": "67793971881188000164",
"deviceName": "nvrsheb9"
}
},
{
"deviceId": "gb_67793971881318000004",
"deviceName": "nvrsheb96",
"createTime": 1721902314000,
"camModelName": "GB",
"deviceStatus": 2,
"deviceSwitch": 1,
"deviceLatitude": "",
"deviceLongitude": "",
"deviceType": "nvr",
"deviceProtocol": "国标协议",
"nvrInfo": {
"deviceId": "67793971881188000164",
"deviceName": "nvrsheb9"
}
}
],
"total": 95,
"page": 1,
"pageSize": 2
}