添加视频设备
更新时间:2022-12-08
接口描述
添加新的RTSP流设备。
请求结构
POST /console/api/v1/device/add
请求头域
请求头名称 | 描述 | 示例 |
---|---|---|
Authorization | 认证头。登录响应返回的token内容,如果不填或者填错会拒绝请求 | Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyTmFtZSI6ImFkbWluIiwiZXhwIjoxNjY3NDc4OTc4fQ.JL9R7CqIhPFdQWZry4e9ONZntUTmNzBp0sDE05rMxl |
请求参数
参数 | 类型 | 是否必选 | 描述 | 示例 |
---|---|---|---|---|
username | String | 是 | 设备RTSP用户名, 如果设备RTSP不需要用户名和密码认证,可以随便写一个,可以为空,长度<=30个中英文字符 | testme |
password | String | 是 | 设备RTSP密码,如果设备RTSP不需要用户名和密码认证,可以随便写一个,可以为空,长度<=30个中英文字符 | pwd1 |
deviceName | String | 是 | 设备名称,不允许为空,长度<=32个中英文字符 | device001 |
deviceRtsp | String | 是 | 设备RTSP流地址,长度<=256个中英文字符 | rtsp://192.168.1.64:554/ |
aiList | Two-dimensional Array | 否 | 要绑定的AI技能列表。二维数组的每一个元素必须是一个长度为1的一维数组。每个一维数组是一个字符串,表示一个AI技能 | 比如添加人脸识别和安全帽识别: [ ["face"], ["hat"] ] |
position | String | 否 | 位置描述,长度<=30个中英文字符 | 大门口 |
manufacturer | String | 否 | 厂商名称,默认为"未设厂商",长度<=96个中英文字符 | 海康威视 |
noRealMerge | boolean | 否 | 是否合成AI视频分析流,仅当aiList不为空时有效,默认为false。如果为true则仅用于AI识别,不提供AI视频分析流供效果展示 | false |
响应头域
无特殊响应头。
响应参数
参数 | 类型 | 描述 |
---|---|---|
status | int32 | 接口返回状态, 0表示成功,其他表示失败 |
message | 字符串 | 成功或错误提示 |
data | JSON | 设备信息 |
deviceId | int64 | 设备ID |
dispatchAddr | 字符串 | 生成的设备原始RTSP分发流地址 |
请求示例
POST /console/api/v1/device/add HTTP/1.1
Content-Type: application/json
Content-Length: 1254
Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyTmFtZSI6ImFkbWluIiwiZXhwIjoxNjY4NjgxODg5fQ.NkjiNOeMnzP9To-CuV4F9306OH1RY0xz69RG4dstTSk
{
"username": "testme",
"password": "pwd1",
"deviceName": "device001",
"deviceRtsp": "rtsp://192.168.1.64:554/",
"aiList": [["face"], ["hat"]],
"noRealMerge": false
}
响应示例
{
"status":0,
"message": “success”,
"data":{
"deviceId": 101,
"dispatchAddr": “rtsp://192.168.1.64:554/dispatch/101”
}
}