1. 设备管理

设备管理


1.1. 添加设备

基础信息

路径: /v1/api/device/add

请求方法: POST

请求参数

Headers:

名称 必须 备注
Content-Type application/json

Body:

名称 类型 必须 默认值 备注
name string 名称
protocol integer 协议
modelUuid string 设备型号uuid
zoneUuid string 区域uuid
uuid string uuid
connectMode integer 1 接入模式 默认正常模式
1 :正常模式接入
2 :主动模式接入
rtspUrl string rtsp url
ipAddress string IP地址
port integer 端口
userName string 用户名
userPassword string 密码
location string 位置
gbCode string GB编码
gaCode string GA编码
snCode string SN编码
deviceDesc string 备注
orgUuid string 组织uuid, 仅添加人证机时使用

Body示例:

{
    "name": "测试IPC",
    "zoneUuid": "0",
    "modelUuid": "bedfb37683694e49bcd32caacd38cf4e",
    "protocol": 1,
    "ipAddress": "10.171.2.116",
    "port": "3000",
    "userName": "admin",
    "userPassword": "admin123",
    "rtspUrl": "rtsp://10.171.2.180:6554/koala_C2_26ren_11.264",
    "connectMode": 1
}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值
  |─uuid string uuid

响应示例:

{
    "code": 0,
    "data": {
        "uuid": "DE-496968c7dbe140f3958d429ac58a964a"
    },
    "msg": "成功"
}

1.2. 删除设备

基础信息

路径: /v1/api/device/delete

请求方法: POST

请求参数

Headers:

名称 必须 备注
Content-Type application/json

Body:

名称 类型 必须 默认值 备注
uuid string uuid

Body示例:

{
    "uuid": "DE-1c84d1c2c727454da30158b4e268807a"
}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值

响应示例:

{
    "code":0,
    "msg":"成功"
}

1.3. 修改设备信息

基础信息

路径: /v1/api/device/update

请求方法: POST

请求参数

Headers:

名称 必须 备注
Content-Type application/json

Body:

名称 类型 必须 默认值 备注
uuid string 设备uuid
zoneUuid string 设备所属区域
name string 名称
rtspUrl string rtsp url
ipAddress string IP地址
port integer 端口
userName string 用户名
userPassword string 密码
location string 位置
deviceDesc string 备注

Body示例:

{
    "uuid": "DE-6cc78307dffc45e1bdce2f4be0ad371a",
    "name": "测试IPC1",
    "ipAddress": "10.171.1.123",
    "rtspUrl": "rtsp://10.171.1.123:8787",
    "port": 3000,
    "userName": "admin",
    "userPassword": "admin123",
    "location": "位置",
    "deviceDesc": "备注1"
}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值

响应示例:

{
    "code":0,
    "msg":"成功"
}

1.4. 查询设备详情

基础信息

路径: /v1/api/device/queryByUuid

请求方法: POST

请求参数

Headers:

名称 必须 备注
Content-Type application/json

Body:

名称 类型 必须 默认值 备注
uuid string uuid
hasOps boolean false 是否查询设备运维详情

Body示例:

{
    "uuid": "DE-6cc78307dffc45e1bdce2f4be0ad371a"
}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值
  |─uuid string uuid
  |─name string 名称
  |─protocol integer 协议
  |─protocolName string 协议名称
  |─modelUuid string 设备型号uuid
  |─connectMode integer 接入模式
1 :正常模式接入
2 :主动模式接入
  |─rtspUrl string rtsp url
  |─ipAddress string IP地址
  |─port integer 端口
  |─userName string 用户名
  |─userPassword string 密码
  |─location string 位置
  |─gbCode string GB编码
  |─gaCode string GA编码
  |─snCode string SN编码
  |─deviceDesc string 备注
  |─orgUuid string 组织uuid,仅人证机使用
  |─upgradeStatus integer 升级状态
0 :正常
1 :rom下载中
2 :rom升级中
3 :app下载中
4 :app升级中
5 :升级成功
6 :升级失败
7 :可升级
8 :升级完成
  |─status integer 设备状态
-2 :初始化异常
3 :在线
4 :离线
  |─zoneName string 区域名称
  |─zoneUuid string 区域uuid
  |─typeCode integer 设备类型
1 :智能摄像头
2 :智能面板机
3 :智能中心服务器
4 :网络摄像机
5 :存储服务器
6 :门禁控制器
7 :智能边缘服务器
2000 :人证机
  |─typeName string 设备类型名称
  |─modelCode integer 设备型号编号
  |─modelName string 设备型号名称
  |─modelBelong integer 设备类型归属
1 :C3S
2 :C4H
3 :C4N
4 :C4R
5 :C4S
6 :W4K
7 :W5K
8 :B3R
9 :CORE
10 :IPC
11 :NVR
12 :W3K
13 :OTHER_IPC
14 :SMART_IPC
15 :门禁控制器
16 :B4H
17 :人证机
9999 :未知类型
  |─orgName string 部门名称
  |─outPort integer 设备外网端口
  |─abilitySet array 能力集编码
    |─ integer
  |─abilitySetText array 能力集描述
    |─ string
  |─hasInternal boolean 是否内置算力
  |─mac string mac地址
  |─computeChip string 算力芯片
  |─version string 版本号
  |─cpuUsage number CPU使用率
  |─cpuTemperature number CPU温度
  |─memoryValue number 内存空间
  |─memoryUsed number 已用内存
  |─diskValue number 存储空间
  |─diskUsed number 已用存储
  |─algorithmVersion string 算法版本
  |─apeNo string APE序列号

响应示例:

{
    "code":0,
    "data":{
        "abilitySet":[
            1
        ],
        "abilitySetText":[
            "视频"
        ],
        "connectMode":1,
        "deviceDesc":"备注1",
        "hasInternal":false,
        "ipAddress":"10.171.1.123",
        "location":"位置",
        "modelBelong":10,
        "modelCode":21,
        "modelName":"IPC",
        "modelUuid":"bedfb37683694e49bcd32caacd38cf4e",
        "name":"测试IPC1",
        "port":3000,
        "protocol":1,
        "protocolName":"rtsp",
        "rtspUrl":"rtsp://10.171.1.123:8787",
        "status":3,
        "typeCode":4,
        "typeName":"网络摄像机",
        "userName":"admin",
        "userPassword":"admin123",
        "uuid":"DE-6cc78307dffc45e1bdce2f4be0ad371a",
        "zoneName":"默认区域",
        "zoneUuid":"0"
    },
    "msg":"成功"
}

1.5. 分页查询设备列表

基础信息

路径: /v1/api/device/list

请求方法: POST

请求参数

Headers:

名称 必须 备注
Content-Type application/json

Body:

名称 类型 必须 默认值 备注
pageNum integer 1 当前页码,不传默认1
pageSize integer 20 分页大小,不传默认20
pointType integer 点位类型(添加点位时过滤点位) 1-门禁点 2-监控点
monitorChannelType integer 监控点通道类型(添加监控点时过滤通道) 1-智能通道 2-视频通道
rootZoneUuid string 0 查询区域的起始节点, 不传则为根区域
hasCurrentZone boolean true 是否仅查询当前区域, 默认true
deviceName string 设备名称
deviceModelType integer 设备类型
1 :智能摄像头
2 :智能面板机
3 :智能中心服务器
4 :网络摄像机
5 :存储服务器
6 :门禁控制器
7 :智能边缘服务器
2000 :人证机
deviceModelUuid string 设备型号uuid
status integer 设备状态
-2 :初始化异常
3 :在线
4 :离线
ipAddress string 设备IP
snCode string SN码
connectMode integer 接入模式
1 :正常模式接入
2 :主动模式接入
abilitySet array 能力集
  |─ integer
version string 版本号
computeChip string 算力芯片
userUuid string

Body示例:

{
    "pageNum": 1,
    "pageSize": 2,
    "hasCurrentZone": false,
    "deviceName": "算力",
    "deviceModelType": 7,
    "status": 3
}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值
  |─pageNum integer 页码,从1开始
当前页码
  |─pageSize integer 页面大小
分页大小
  |─total integer 总记录数
总数
  |─list array
    |─ object
      |─uuid string uuid
      |─name string 名称
      |─protocol integer 协议
      |─protocolName string 协议名称
      |─modelUuid string 设备型号uuid
      |─connectMode integer 接入模式
1 :正常模式接入
2 :主动模式接入
      |─rtspUrl string rtsp url
      |─ipAddress string IP地址
      |─port integer 端口
      |─userName string 用户名
      |─userPassword string 密码
      |─location string 位置
      |─gbCode string GB编码
      |─gaCode string GA编码
      |─snCode string SN编码
      |─deviceDesc string 备注
      |─orgUuid string 组织uuid,仅人证机使用
      |─upgradeStatus integer 升级状态
0 :正常
1 :rom下载中
2 :rom升级中
3 :app下载中
4 :app升级中
5 :升级成功
6 :升级失败
7 :可升级
8 :升级完成
      |─status integer 设备状态
-2 :初始化异常
3 :在线
4 :离线
      |─zoneName string 区域名称
      |─zoneUuid string 区域uuid
      |─typeCode integer 设备类型
1 :智能摄像头
2 :智能面板机
3 :智能中心服务器
4 :网络摄像机
5 :存储服务器
6 :门禁控制器
7 :智能边缘服务器
2000 :人证机
      |─typeName string 设备类型名称
      |─modelCode integer 设备型号编号
      |─modelName string 设备型号名称
      |─modelBelong integer 设备类型归属
1 :C3S
2 :C4H
3 :C4N
4 :C4R
5 :C4S
6 :W4K
7 :W5K
8 :B3R
9 :CORE
10 :IPC
11 :NVR
12 :W3K
13 :OTHER_IPC
14 :SMART_IPC
15 :门禁控制器
16 :B4H
17 :人证机
9999 :未知类型
      |─orgName string 部门名称
      |─outPort integer 设备外网端口
      |─abilitySet array 能力集编码
        |─ integer
      |─abilitySetText array 能力集描述
        |─ string
      |─hasInternal boolean 是否内置算力
      |─mac string mac地址
      |─computeChip string 算力芯片
      |─version string 版本号
      |─cpuUsage number CPU使用率
      |─cpuTemperature number CPU温度
      |─memoryValue number 内存空间
      |─memoryUsed number 已用内存
      |─diskValue number 存储空间
      |─diskUsed number 已用存储
      |─algorithmVersion string 算法版本
      |─apeNo string APE序列号

响应示例:

{
    "code":0,
    "data":{
        "list":[
            {
                "abilitySet":[
                    5,
                    3,
                    9,
                    4,
                    8,
                    6,
                    1
                ],
                "abilitySetText":[
                    "报警",
                    "识别",
                    "恢复出厂设置",
                    "全结构化",
                    "校时(ntp或者实时)",
                    "固件升级",
                    "视频"
                ],
                "connectMode":1,
                "deviceDesc":"内置算力引擎",
                "hasInternal":true,
                "ipAddress":"169.254.255.10",
                "location":"内置",
                "modelBelong":16,
                "modelCode":69,
                "modelName":"MegCube-B4H16-311",
                "modelUuid":"7d277e0dc38a4057a4a1f056c5556565",
                "name":"算力引擎1",
                "outPort":6789,
                "port":8080,
                "protocol":3,
                "protocolName":"MegConnect",
                "status":3,
                "typeCode":7,
                "typeName":"智能边缘服务器",
                "userName":"admin",
                "userPassword":"Megvii123",
                "uuid":"DE-8b31289374c34bafa627a614ab9fa850",
                "version":"V2.0.1",
                "zoneName":"默认区域",
                "zoneUuid":"0"
            }
        ],
        "pageNum":1,
        "pageSize":2,
        "total":1
    },
    "msg":"成功"
}

1.6. 发现设备列表

基础信息

路径: /v1/api/device/queryReportDevice

请求方法: POST

请求参数

Headers:

名称 必须 备注
Content-Type application/json

Body:

名称 类型 必须 默认值 备注
pageNum integer 1 当前页码,不传默认1
pageSize integer 20 分页大小,不传默认20
deviceTypeCode integer 设备类型 1-智能摄像头 2-智能面板机 3-智能中心服务器 4-网络摄像机 5-存储服务器 6-门禁控制器 7-智能边缘服务器 2000-人证机
snCode string 设备序列号
protocol integer 协议
code string 设备编码

Body示例:

{
    "pageNum": 1,
    "pageSize": 20,
    "deviceTypeCode": 2,
    "snCode": "SM88872312",
    "protocol": 4,
    "code": "M1232323"
}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值
  |─pageNum integer 页码,从1开始
当前页码
  |─pageSize integer 页面大小
分页大小
  |─total integer 总记录数
总数
  |─list array
    |─ object
      |─uuid string uuid
      |─modelUuid string 设备型号uuid
      |─snCode string sn编码
      |─gmtCreate string 操作时间
      |─deviceProtocol integer 设备协议编码
      |─modelCode integer 设备型号编码
      |─typeCode integer 设备类型
1 :智能摄像头
2 :智能面板机
3 :智能中心服务器
4 :网络摄像机
5 :存储服务器
6 :门禁控制器
7 :智能边缘服务器
2000 :人证机
      |─deviceName string 设备名字
      |─modelCodeName string 设备型号名称
      |─typeCodeName string 设备类型名称
      |─protocolName string 设备协议名称
      |─discoveryMethod integer 主动注册类型 1-meglink 2-pdns 3-门禁机

响应示例:

{
    "code":0,
    "data":{
        "list":[
            {
                "deviceName":"MegEye-W5K-I8",
                "deviceProtocol":4,
                "discoveryMethod":1,
                "ipAddress":"",
                "modelCode":1,
                "modelCodeName":"MegEye-W5K-I8",
                "modelUuid":"06167652818b4e7883c96585da58fafb",
                "protocolName":"Meglink",
                "snCode":"M014200332004000094",
                "typeCode":2,
                "typeCodeName":"智能面板机",
                "uuid":"46f78f6ad92d4fe0ae8aa4c7736db42b"
            }
        ],
        "pageNum":1,
        "pageSize":10,
        "total":1
    },
    "msg":"成功"
}

1.7. 设备型号列表查询

基础信息

路径: /v1/api/device/queryDeviceModel

请求方法: POST

请求参数

Headers:

名称 必须 备注
Content-Type application/json

Body:

名称 类型 必须 默认值 备注
typeCode integer 设备类型
1 :智能摄像头
2 :智能面板机
3 :智能中心服务器
4 :网络摄像机
5 :存储服务器
6 :门禁控制器
7 :智能边缘服务器
2000 :人证机
modelCode integer 设备具体型号

Body示例:

{
    "typeCode": 4,
    "modelCode": 6
}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data array 具体的返回值
  |─ object
    |─uuid string uuid
    |─typeCode integer 设备类型
1 :智能摄像头
2 :智能面板机
3 :智能中心服务器
4 :网络摄像机
5 :存储服务器
6 :门禁控制器
7 :智能边缘服务器
2000 :人证机
    |─typeName string 设备类型名称
    |─modelCode integer 设备型号编号
    |─modelName string 设备型号名称,如W5K-I8
    |─modelBelong integer 设备型号类别
1 :C3S
2 :C4H
3 :C4N
4 :C4R
5 :C4S
6 :W4K
7 :W5K
8 :B3R
9 :CORE
10 :IPC
11 :NVR
12 :W3K
13 :OTHER_IPC
14 :SMART_IPC
15 :门禁控制器
16 :B4H
17 :人证机
9999 :未知类型
    |─supportProtocol string 支持的协议类型
    |─hasSupportActiveSdk boolean 是否支持activeSDK的设备型号

响应示例:

{
    "code":0,
    "data":[
        {
            "hasSupportActiveSdk":true,
            "modelBelong":2,
            "modelCode":6,
            "modelName":"MegEye-C4H-241",
            "supportProtocol":"[{\"supportProtocol\":1,\"supportProtocolStr\":\"rtsp\",\"active\":true},{\"supportProtocol\":2,\"supportProtocolStr\":\"onvif\",\"active\":false},{\"supportProtocol\":5,\"supportProtocolStr\":\"GB/T28181\",\"active\":false}]",
            "typeCode":4,
            "typeName":"网络摄像机",
            "uuid":"92d3232509ec476c9726db6ace0282ac"
        }
    ],
    "msg":"成功"
}

1.8. 查询设备通道列表

基础信息

路径: /v1/api/device/queryChannelList

请求方法: POST

请求参数

Headers:

名称 必须 备注
Content-Type application/json

Body:

名称 类型 必须 默认值 备注
deviceUuid string 设备uuid
filterPointType integer 0 过滤类型,0-不过滤(默认) 1-过滤掉已经添加为门禁点的通道 2-过滤掉已经添加为监控点的通道
pageNum integer 1 页码,从1开始
当前页码,不传默认1
pageSize integer 20 页面大小
分页大小,不传默认20

Body示例:

{
    "pageNum": 1,
    "pageSize": 20,
    "deviceUuid": "46d3b2c290e944e0a5ad5926f63e6629",
    "filterPointType": 0
}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值
  |─pageNum integer 页码,从1开始
当前页码
  |─pageSize integer 页面大小
分页大小
  |─total integer 总记录数
总数
  |─list array
    |─ object
      |─uuid string 通道uuid
      |─name string 通道名称
      |─channelNo integer 通道号
      |─channelStatus integer 通道状态
-2 :初始化异常
3 :在线
4 :离线
      |─rtspUrl string 视频流地址
      |─gbCode string GB28181编码
      |─memo string 备注
      |─location string 通道位置
      |─hasDoorPoint boolean 通道是否已经被添加为门禁点
      |─hasMonitorPoint boolean 通道是否已经被添加为监控点
      |─abilitySet array 能力集
        |─ integer
      |─abilitySetText array 能力集描述
        |─ string
      |─enableDoorPoint boolean true 通道是否可以添加为门禁点
      |─enableMonitorPoint boolean true 通道是否可以添加为监控点

响应示例:

{
    "code":0,
    "data":{
        "list":[
            {
                "abilitySet":[
                    3
                ],
                "abilitySetText":[
                    "识别"
                ],
                "channelNo":1,
                "channelStatus":4,
                "enableDoorPoint":true,
                "enableMonitorPoint":false,
                "gbCode":"",
                "hasDoorPoint":false,
                "hasMonitorPoint":false,
                "location":"",
                "memo":"",
                "name":"panel_channel_46d3b2c290e944e0a5ad5926f63e6629",
                "rtspUrl":"",
                "uuid":"CH-d60f9b3a2f894a6fa469"
            }
        ],
        "pageNum":1,
        "pageSize":20,
        "total":1
    },
    "msg":"成功"
}

1.9. 校验设备是否布控和关联点位

基础信息

路径: /v1/api/device/checkControl

请求方法: POST

请求参数

Headers:

名称 必须 备注
Content-Type application/json

Body:

名称 类型 必须 默认值 备注
deviceUuidList array 设备列表
  |─ string

Body示例:

{
    "deviceUuidList": ["DE-8b31289374c34bafa627a614ab9fa850"]
}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值
  |─hasControl boolean 是否布控
  |─hasLinkPoint boolean 是否关联点位

响应示例:

{
    "code": 0,
    "data": {
        "hasControl": true,
        "hasLinkPoint": true
    },
    "msg": "成功"
}

results matching ""

    No results matching ""