查询视频设备列表
更新时间：2022-12-08
接口描述
查询RTSP流设备列表，支持关键字过滤。
请求结构
POST /console/api/v1/device/list
请求头域
| 请求头名称 | 描述 | 示例 |
|---|---|---|
| Authorization | 认证头。登录响应返回的token内容，如果不填或者填错会拒绝请求 | Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyTmFtZSI6ImFkbWluIiwiZXhwIjoxNjY3NDc4OTc4fQ.JL9R7CqIhPFdQWZry4e9ONZntUTmNzBp0sDE05rMxl |
请求参数
| 参数 | 类型 | 是否必选 | 描述 | 示例 |
|---|---|---|---|---|
| status | Array | 是 | 状态过滤的字符串数组。设备状态包括：正常运行、已离线、已关闭。 | [ "正常运行", "已离线" ] |
| filter | String | 否 | 关键字过滤，如果为空则忽略关键字匹配。如果设备的名称、RTSP地址、厂商、位置中的任何一个字段包含filter关键字，则满足匹配。 status和filter二者是AND的关系 | 192.168.1.64 |
| pageSize | Int32 | 是 | 分页查询的每页记录数 | 20 |
| pageNum | Int32 | 是 | 分页查询的页号，最小为1 | 5 |
| total | Boolean | 否 | 是否返回符合条件的记录总数 | true |
响应头域
无特殊响应头。
响应参数
注意：返回结果首先按照createAt从大到小排序，createAt相同时按照deviceName字典序从小到大排序。
| 参数 | 类型 | 描述 |
|---|---|---|
| status | Int32 | 接口返回状态, 0表示成功，其他表示失败 |
| message | String | 成功或错误提示 |
| data | JSON | 设备信息 |
| list | Array | 设备信息数组 |
| +id | Int64 | 视频设备的唯一标识ID |
| +deviceName | String | 设备名称 |
| +position | String | 设备位置 |
| +manufacturer | String | 设备厂商 |
| +createAt | String | 设备创建时间，日期字符串，精确到秒 |
| +status | String | 设备状态。例如： “正常运行” |
| pages | Map | 页数信息 |
| +total | Int32 | 符合条件的记录总数，仅当请求的total为true是有效 |
请求示例
Java
1POST /console/api/v1/device/list
2Content-Type: application/json
3Content-Length: 1254
4Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyTmFtZSI6ImFkbWluIiwiZXhwIjoxNjY4NjgxODg5fQ.NkjiNOeMnzP9To-CuV4F9306OH1RY0xz69RG4dstTSk
5
6{
7"status": ["正常运行", "离线"],
8"filter": "192.168.3.4",
9"pageSize": 20,
10"pageNum": 3,
11"total": true
12}响应示例
Java
1{
2 "status": 0,
3 "message": "success",
4 "data": {
5 "list": [
6 {
7 "id": 70,
8 "status": "正常运行",
9 "deviceName": "22",
10 "createAt": "2022-04-29 17:40:38",
11 "position": "大门口",
12 "manufacturer": "海康威视"
13 },
14 {
15 "id": 62,
16 "status": "已禁用",
17 "deviceName": "18",
18 "createAt": "2022-04-29 17:36:06",
19 "position": "保安亭",
20 "manufacturer": "大华"
21 },
22 {
23 "id": 24,
24 "status": "离线",
25 "deviceName": "a",
26 "createAt": "2022-04-29 10:29:34",
27 "position": "超市门口",
28 "manufacturer": "海康威视"
29 }
30 ],
31 "pages": {
32 "total": 3
33 }
34 }
35}