2 AI设备管理API

API列表

编号 API名称 路径 版本
2.1 编辑设备信息 /ai/bas/plus/device/update 1.0
2.2 AI设备信息列表 /ai/bas/plus/device/list 1.0
2.3 AI设备信息明细 /ai/bas/plus/device/detail 1.0
2.4 手动同步AI设备信息 /ai/bas/plus/device/update/status 1.0
2.5 清空设备扩展信息 /ai/bas/plus/device/update/delete 1.0

2.1: 编辑设备信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/ai/bas/plus/device/update

方法：POST

请求参数

名称 位置 类型 必填 描述
plusId BODY LONG 否 扩展id
cloudDeviceId BODY LONG 否 云端设备id
deviceId BODY LONG 否 设备id
deviceName BODY STRING 是 设备名称
deviceType BODY INTEGER 是 设备类型 1-IPC设备 2-NVR网关
protocolType BODY STRING 是 协议类型 1-ONVIF协议 2-GB协议
ip BODY STRING 否 ip地址
port BODY INTEGER 否 端口
userName BODY STRING 否 用户名
password BODY STRING 否 密码
isoId BODY STRING 否 国际id

请求Body描述(非Form表单数据)

{
    "plusId": 10,
    "deviceName": "",
    "deviceType": 1,
    "protocolType": 1,
    "ip": "",
    "port": 2000,
    "userName": "",
    "password": "",
    "cloudDeviceId":44
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
    "code": 200,
    "message": "success"
}

2.2: AI设备信息列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/ai/bas/plus/device/list

方法：POST

请求参数

名称 位置 类型 必填 描述
limit BODY STRING 是 每页数量
order BODY INTEGER 是 排序
query BODY STRING 是 条件

请求Body描述(非Form表单数据)

{
    "limit": 10,
    "offset": 0,
    "order": {
        "create_time": "desc"
    },
    "query": {
        "project_id": {
            "$eq": "21441118"
        },
        "source_system": {
            "$eq": "video_surveillance"
        }
    }
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
cameraStatus DATA INTEGER 是 地摄像头状态 0-下线 1-上线
cloudStatus DATA INTEGER 是 云端状态 0-未激活 1-在线 2-离线
deviceId DATA INTEGER 是 设备id
deviceName DATA INTEGER 是 设备名称
deviceType DATA INTEGER 是 设备类型 1-设备 2-网关
protocolType DATA INTEGER 是 协议类型 1-ONVIF协议 2-GB协议
toCloudStatus DATA INTEGER 是 同步到云端状态 0-不存在数据 1-已同步 2-未同步
updateTime DATA INTEGER 是 最后上线时间
cloudDeviceId DATA INTEGER 是 云端设备id
cameraType DATA INTEGER 是 摄像头类型 0-非AI摄像头 1-AI摄像头
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

 "code": 200,
    "data": {
        "list": [
            {
                "cameraStatus": 0,
                "cloudStatus": 0,
                "deviceId": 452875807,
                "deviceName": "新增摄像头02",
                "deviceType": 0,
                "protocolType": 0,
                "toCloudStatus": 0,
                "updateTime": "",
                "cloudDeviceId": 0,
                "cameraType": ""
            },
            {
                "cameraStatus": 0,
                "cloudStatus": 0,
                "deviceId": 452876632,
                "deviceName": "海康摄像头",
                "deviceType": 0,
                "protocolType": 0,
                "toCloudStatus": 0,
                "updateTime": "",
                "cloudDeviceId": 0,
                "cameraType": ""
            }
        ],
        "count": 10,
        "current_page": null,
        "per_page": null
    },
    "message": "success"
}

2.3: AI设备信息明细

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/ai/bas/plus/device/detail

方法：POST

请求参数

名称 位置 类型 必填 描述
plusId BODY LONG 是 扩展id

请求Body描述(非Form表单数据)

{
    "plusId": 10
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
deviceName DATA STRING 是 设备名称
deviceType DATA INTEGER 是 设备类型 1-设备 2-网关
protocolType DATA STRING 是 协议类型 1-ONVIF协议 2-GB协议
ip DATA STRING 否 ip地址
port DATA INTEGER 否 端口
userName DATA STRING 否 用户名
password DATA STRING 否 密码
isoId DATA STRING 否 国际id
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
    "code": 200,
    "message": "success",
    "data":{
        "plusId": 10,
        "deviceName": "",
        "deviceType": 1,
        "protocolType": 1,
        "ip": "",
        "port": 2000,
        "userName": "",
        "password": ""
    }
}

2.4: 手动同步AI设备信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/ai/bas/plus/device/update/status

方法：POST

请求参数

名称 位置 类型 必填 描述
plusId BODY LONG 是 扩展id

请求Body描述(非Form表单数据)

{
    "plusId": 10
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
    "code": 200,
    "message": "success"
}

2.5: 清空设备扩展信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/ai/bas/plus/device/update/delete

方法：POST

请求参数

名称 位置 类型 必填 描述
plusId BODY LONG 是 扩展id

请求Body描述(非Form表单数据)

{
    "plusId": 10
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
    "code": 200,
    "message": "success"
}

错误码列表(31001-31099)

错误码 错误信息 描述
31001 face detect failure 人脸检测失败
公共错误码 -- 所有API公用的错误码，请参照《 公共错误码 》

results matching ""

    No results matching ""