全部产品
云市场

设备管理

更新时间:2020-03-24 20:44:39

1添加设备到小区

path 版本 描述
/solution/community/paas/device/add
1.0.0 添加设备到小区

请求参数

入参名称 数据类型 是否必须 入参描述
communityId Long
小区id
deviceIdentity JsonObject 详见DeviceIdentityDTO

返回结果

返回结果使用通用结果类型,不使用data域。

2从小区删除设备

path 版本 描述
/solution/community/paas/device/remove
1.0.0 从小区删除设备

请求参数

入参名称 数据类型 是否必须 入参描述
communityId Long
小区id
deviceIdentity JsonObject 详见DeviceIdentityDTO

返回结果

返回结果使用通用结果类型,不使用data域。

3小区设备列表

path 版本 描述
/solution/community/paas/device/query 1.0.0 小区设备列表

请求参数

入参名称 数据类型 是否必须 入参描述
communityId Long
小区id
pageNo 整型 当前页,从1开始
pageSize
整型 每页大小,最大100

返回结果

字段名 类型 备注
data JSON

4租户设备列表

path 版本 描述
/solution/community/paas/tenant/device/query 1.0.0 租户设备列表

请求参数

入参名称 数据类型 是否必须 入参描述
queryType String 查询类型OWNED本租户设备,AUTHORIZED 授权设备
pageNo 整型 当前页,从1开始
pageSize
整型 每页大小,最大100

返回结果

字段名 类型 备注
data JSON JsonArray详见DeviceDTO


DeviceDTO

参数名称 数据类型 参数描述
iotId String 设备Id
productImage String 设备的产品图片
deviceName String 设备名称
nickName String 设备昵称
productKey String 产品PK
productName String 产品名称
nodeType String 0:DEVICE 1:GATEWAY
status Integer 0 离线 1在线 -1未激活

5查询推流地址

获取摄像头实时视频流服务

path 版本 描述
/vision/stream/query 2.0.0 查询推流地址

请求参数

入参名称 数据类型 是否必须 入参描述
iotId 字符串 设备id
streamType 整型 流类型,0表示主码流,1表示辅码流
encrypted 布尔 是否加密
encryptType 整型 加密类型,0表示关键帧加密
forceIFrame 布尔 强制I帧
scheme 字符串 协议类型,支持 rtmp/hls

返回结果

参数名称 数据类型 参数描述
data JSON 视频流

视频流结构

参数名称 数据类型 参数描述
path 字符串 直播地址
decryptKey JSON 解密密钥
iv 字符串 向量base64值
key 字符串 密钥base64值

6获取录像记录

获取NVR上的录像记录,用于1.11.4播放

path 版本 描述
/vision/record/query 2.0.0 获取录像记录

请求参数

入参名称 数据类型 是否必须 入参描述
iotId 字符串 设备ID
streamType 整型 码流类型,0表示主码流,1表示辅码流
beginTime 整型 查询开始时间,1970年1月1日0点开始的秒数
endTime 整型 查询结束时间,1970年1月1日0点开始的秒数
recordType 整型 录像类型,0表示计划录像,1表示报警录像,2表示主动录像,3表示边看边录,99表示所有录像
pageNo 整型 起始页数,从0开始
pageSize 整型 分页大小
needSnapshot 布尔 是否需要录像缩略图

返回结果

参数名称 数据类型 参数描述
data JSON 录像结果

录像结果

参数名称 数据类型 参数描述
recordFileList JSON 录像文件列表
beginTime 字符串 文件开始时间,格式yyyy-MM-dd HH:mm:ss
endTime 字符串 文件结束时间,格式yyyy-MM-dd HH:mm:ss
recordType 整型 录像类型
streamType 整型 码流类型
fileName 字符串 文件名
fileSize 整型 文件大小
snapshotUrl 字符串 录像缩略图URL
nextValid 布尔 下一页是否有效
nextBeginTime 整型 下一页起始时间


7获取历史文件播放地址

获取录像记录的播放地址

path 版本 描述
/vision/vod/getbyfilename 2.0.0 获取录像记录播放地址

请求参数

入参名称 数据类型 是否必须 入参描述
iotId 字符串 设备ID
fileName 字符串 文件名,录像查询接口返回

返回结果

参数名称 数据类型 参数描述
data JSON 响应结果,结果请查看下一列
vodUrl 字符串 点播地址,带鉴权信息,无法重复点播使用