1. 设备管理

设备管理

1.1. 添加设备

基础信息

路径: /v1/api/device/add

请求方法: POST

请求参数

Headers:

Body:

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:

Body:

响应示例:

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

1.2. 删除设备

基础信息

路径: /v1/api/device/delete

请求方法: POST

请求参数

Headers:

Body:

Body示例:

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

返回数据

Headers:

Body:

响应示例:

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

1.3. 修改设备信息

基础信息

路径: /v1/api/device/update

请求方法: POST

请求参数

Headers:

Body:

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:

Body:

响应示例:

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

1.4. 查询设备详情

基础信息

路径: /v1/api/device/queryByUuid

请求方法: POST

请求参数

Headers:

Body:

Body示例:

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

返回数据

Headers:

Body

响应示例:

{
    "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",
        "faceCompareOption":1
    },
    "msg":"成功"
}

1.5. 分页查询设备列表

基础信息

路径: /v1/api/device/list

请求方法: POST

请求参数

Headers:

Body:

Body示例:

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

返回数据

Headers:

Body:

响应示例:

{
    "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:

Body:

Body示例:

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

返回数据

Headers:

Body:

响应示例:

{
    "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:

Body:

Body示例:

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

返回数据

Headers:

Body:

响应示例:

{
    "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:

Body:

Body示例:

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

返回数据

Headers:

Body:

响应示例:

{
    "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:

Body:

Body示例:

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

返回数据

Headers:

Body:

响应示例:

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

1.10. 查询支持指定功能的设备列表

基础信息

路径: /v1/api/device/search/function

请求方法: POST

请求参数

Headers:

Body:

Body示例:

{
  "type": "palm"
}

返回数据

Headers:

Body:

响应示例:

{
    "code":0,
    "data":[
        {
            "name":"LX掌纹机",
            "uuid":"7aae2f26447445428fac5e232cb49765"
        },
        {
            "name":"KK掌纹test",
            "uuid":"56f59804c5f543258dea11df8c6bd0a6"
        }
    ],
    "msg":"成功"
}

1.11. 添加设备通道

仅B4H 3.0版本及以上版本支持。

基础信息

Path： /v1/api/device/resource/device/addChannel

Method： POST

请求参数

Headers

Body

Body示例:

{
    "deviceUuid": "DE-3edad7ec83df44988e52bc49b3607d42",
    "rtspUrl": "rtsp://10.231.105.96:8554/hongtu/koala_C2_26ren_01.264"
}

返回数据

Headers:

Body

响应示例:

{
    "code":0,
    "data":{
        "uuid":"CH-a3483222a3a24f599b82"
    },
    "msg":"成功"
}

1.12. 删除设备通道

仅B4H 3.0版本及以上版本支持。

基础信息

Path： /v1/api/device/resource/device/deleteChannel

Method： POST

请求参数

Headers

Body

Body示例:

{
    "uuid": "CH-a3483222a3a24f599b82"
}

返回数据

Headers:

Body

响应示例:

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

1.13. 指定边缘算力设备为1:N设备

存在core时无法指定且仅魔方B4H/B4X支持被指定1:N设备，当全量底库超过30W时，不支持指定魔方为1:N设备。

基础信息

Path： /v1/api/device/bindAllGroup

Method： POST

请求参数

Headers

Body

Body示例:

{
    "uuid": "DE-83f80ec4974d40c2aca898999be010de"
}

返回数据

Headers:

Body

响应示例:

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