中科图灵开放平台 / 智慧消防视频管理模块 / 通过设备id获取算法配置

通过设备id获取算法配置

接口描述: 通过设备id获取算法配置

HTTP/HTTPS
请求协议
GET
请求方式
UTF-8
编码格式
JSON
返回格式
v1.0
版本号

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
videoId整型必须-视频设备id 示例1
apiRequestRaw字符串可选-
headerInfo字符串可选-[]

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.code字符串
data.msg字符串
data.dataArray
data.data>>id字符串配置id
data.data>>videoId字符串视频设备id
data.data>>platformId字符串算法平台id
data.data>>platformHostIds字符串配置的算法主机id
data.data>>platformTypes数组算法分析类型
data.data>>platformTypes>>hostId字符串算法主机id
data.data>>platformTypes>>cameraNumber字符串已配置摄像数
data.data>>platformTypes>>analysisTypeId字符串算法分析类型id
data.data>>platformTypes>>analysisTypeName字符串算法分析类型名
data.data>>platformTypes>>cameraLimit字符串最大摄像头配置数
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
videoId 必须
apiRequestRaw 可选
headerInfo 可选

客户端请求示例

成功响应返回示例:
{
    "code": 0,
    "msg": null,
    "data": {
        "id": 1,
        "videoId": 5,
        "platformId": 1,
        "platformHostIds": "2,3",
        "platformTypes": [
            {
                "hostId": 1,
                "cameraNumber": 1,
                "analysisTypeId": 9610,
                "analysisTypeName": "火焰检测(dev)",
                "cameraLimit": 6
            },
            {
                "hostId": 2,
                "cameraNumber": 3,
                "analysisTypeId": 9684,
                "analysisTypeName": "写字楼烟雾识别",
                "cameraLimit": 6
            },
            {
                "hostId": 3,
                "cameraNumber": 2,
                "analysisTypeId": 9650,
                "analysisTypeName": "写字楼消防门堵塞检测",
                "cameraLimit": 6
            }
        ]
    }
}
失败响应返回示例:

错误列表

错误状态码错误描述信息
400ret=400,客户端参数错误或非法请求
404表示接口服务不存在
406ret=406,access_token令牌校验不通过
407ret=407,app_key权限不足,或未知应用
408ret=408,当前用户禁止使用,或用户未登录
409ret=409,接口流量不足
500表示服务端内部错误

本文档生成时间:2024-04-28 13:02:35