設備管理
注意：設備請先在應用服務平臺添加到項目，再添加到小區(qū)
1.1 添加設備到小區(qū)
path | 版本 | 描述 |
/solution/community/paas/device/add | 1.0.2 | 添加設備到小區(qū) |
請求參數(shù)
入?yún)⒚Q | 數(shù)據(jù)類型 | 是否必須 | 入?yún)⒚枋?/p> |
deviceIdentity | JsonObject | 是 | 詳見DeviceIdentityDTO |
nickName | String | 否 | 設備別名 |
DeviceIdentityDTO
字段名 | 類型 | 必填 | 備注 |
type | String | 是 | IOT_ID/PK_AND_DN |
iotId | String | 否 | 設備id |
productKey | String | 否 | 產(chǎn)品PK |
deviceName | String | 否 | 產(chǎn)品DN |
返回結果使用通用結果類型，不使用data域。
1.2 從小區(qū)刪除設備
path | 版本 | 描述 |
/solution/community/paas/device/remove | 1.0.1 | 從小區(qū)刪除設備 |
請求參數(shù)
入?yún)⒚Q | 數(shù)據(jù)類型 | 是否必須 | 入?yún)⒚枋?/p> |
deviceIdentity | JsonObject | 是 | 詳見DeviceIdentityDTO |
返回結果使用通用結果類型，不使用data域。
1.3 小區(qū)設備列表
path | 版本 | 描述 |
/solution/community/paas/device/query | 1.0.2 | 小區(qū)設備列表 |
請求參數(shù)
入?yún)⒚Q | 數(shù)據(jù)類型 | 是否必須 | 入?yún)⒚枋?/p> |
pageNo | 整型 | 是 | 當前頁，從1開始 |
pageSize | 整型 | 是 | 每頁大小，最大100 |
categoryKey | 字符串 | 否 | 設備的品類。例如梯控設備的品類是ElevatorController |
返回結果
字段名 | 類型 | 備注 |
data | JSON | JsonArray 詳見DeviceDTO |
1.4 租戶設備列表
path | 版本 | 描述 |
/solution/community/paas/tenant/device/query | 1.0.1 | 租戶設備列表 |
請求參數(shù)
入?yún)⒚Q | 數(shù)據(jù)類型 | 是否必須 | 入?yún)⒚枋?/p> |
queryType | String | 是 | 查詢類型OWNED本租戶設備，AUTHORIZED 授權設備 |
pageNo | 整型 | 是 | 當前頁，從1開始 |
pageSize | 整型 | 是 | 每頁大小，最大100 |
返回結果
字段名 | 類型 | 備注 |
data | JSON | JsonArray 詳見DeviceDTO |
DeviceDTO
參數(shù)名稱 | 數(shù)據(jù)類型 | 參數(shù)描述 |
iotId | String | 設備Id |
productImage | String | 設備的產(chǎn)品圖片 |
deviceName | String | 設備名稱 |
nickName | String | 設備昵稱 |
productKey | String | 產(chǎn)品PK |
productName | String | 產(chǎn)品名稱 |
nodeType | String | 0:DEVICE 1:GATEWAY |
status | Integer | 0 離線 1在線 -1未激活 |
categoryName | String | 設備所屬品類名稱 |
categoryKey | String | 設備所屬品類key |
thingType | String | 設備的類型：VIRTUAL、WEB、APP、DEVICE |
lastOnlineTime | String | 設備最后上線時間 |
1.5 查詢推流地址
獲取攝像頭實時視頻流服務
該接口不需要cloudtoken
path | 版本 | 描述 |
/vision/stream/query | 2.1.0 | 查詢推流地址 |
請求參數(shù)
入?yún)⒚Q | 數(shù)據(jù)類型 | 是否必須 | 入?yún)⒚枋?/p> |
iotId | 字符串 | 是 | 設備id |
streamType | 整型 | 否 | 流類型，0表示主碼流，1表示輔碼流 |
encrypted | 布爾 | 否 | 是否加密 |
encryptType | 整型 | 否 | 加密類型，0表示關鍵幀加密 |
forceIFrame | 布爾 | 否 | 強制I幀 |
scheme | 字符串 | 否 | 協(xié)議類型，支持 rtmp/hls/flv |
返回結果
參數(shù)名稱 | 數(shù)據(jù)類型 | 參數(shù)描述 |
data | JSON | 視頻流 |
視頻流結構
參數(shù)名稱 | 數(shù)據(jù)類型 | 參數(shù)描述 |
path | 字符串 | 直播地址 |
decryptKey | JSON | 解密密鑰 |
iv | 字符串 | 向量base64值 |
key | 字符串 | 密鑰base64值 |
1.6 獲取錄像記錄
獲取NVR上的錄像記錄，用于1.11.4播放
該接口不需要cloudtoken
path | 版本 | 描述 |
/vision/record/query | 2.0.0 | 獲取錄像記錄 |
請求參數(shù)
入?yún)⒚Q | 數(shù)據(jù)類型 | 是否必須 | 入?yún)⒚枋?/p> |
iotId | 字符串 | 是 | 設備ID |
streamType | 整型 | 否 | 碼流類型，0表示主碼流，1表示輔碼流 |
beginTime | 整型 | 是 | 查詢開始時間，1970年1月1日0點開始的秒數(shù) |
endTime | 整型 | 是 | 查詢結束時間，1970年1月1日0點開始的秒數(shù) |
recordType | 整型 | 否 | 錄像類型，0表示計劃錄像，1表示報警錄像，2表示主動錄像，3表示邊看邊錄，99表示所有錄像 |
pageNo | 整型 | 否 | 起始頁數(shù)，從0開始 |
pageSize | 整型 | 否 | 分頁大小 |
needSnapshot | 布爾 | 否 | 是否需要錄像縮略圖 |
返回結果
參數(shù)名稱 | 數(shù)據(jù)類型 | 參數(shù)描述 |
data | JSON | 錄像結果 |
錄像結果
參數(shù)名稱 | 數(shù)據(jù)類型 | 參數(shù)描述 |
recordFileList | JSON | 錄像文件列表 |
beginTime | 字符串 | 文件開始時間，格式y(tǒng)yyy-MM-dd HH:mm:ss |
endTime | 字符串 | 文件結束時間，格式y(tǒng)yyy-MM-dd HH:mm:ss |
recordType | 整型 | 錄像類型 |
streamType | 整型 | 碼流類型 |
fileName | 字符串 | 文件名 |
fileSize | 整型 | 文件大小 |
snapshotUrl | 字符串 | 錄像縮略圖URL |
nextValid | 布爾 | 下一頁是否有效 |
nextBeginTime | 整型 | 下一頁起始時間 |
1.7 獲取歷史文件播放地址
獲取錄像記錄的播放地址
該接口不需要cloudtoken
path | 版本 | 描述 |
/vision/vod/getbyfilename | 2.0.0 | 獲取錄像記錄播放地址 |
請求參數(shù)
入?yún)⒚Q | 數(shù)據(jù)類型 | 是否必須 | 入?yún)⒚枋?/p> |
iotId | 字符串 | 是 | 設備ID |
fileName | 字符串 | 是 | 文件名，錄像查詢接口返回 |
返回結果
參數(shù)名稱 | 數(shù)據(jù)類型 | 參數(shù)描述 |
data | JSON | 響應結果，結果請查看下一列 |
vodUrl | 字符串 | 點播地址，帶鑒權信息，無法重復點播使用 |
1.8 攝像頭信息維護
錄入接口
http://bestwisewords.com/document_detail/140317.html?spm=a2c4g.11174283.6.656.3eb152d0h4ulQY
API名稱 | API描述 | API Path | API 版本 |
|---|---|---|---|
新增/查詢數(shù)據(jù) | 基于已經(jīng)創(chuàng)建且被授權寫入的模型，進行數(shù)據(jù)的新增。 | /data/model/data/insert /data/model/data/query | 0.0.3 |
模型ID | 版本 |
·VideoDeviceInfo | 1.1 |
屬性名稱 | 屬性標識符 | 數(shù)據(jù)類型 | 數(shù)據(jù)描述 | 是否必須 |
|---|---|---|---|---|
視頻設備Id | deviceId | String | 視頻設備Id | 是 |
設備別名 | name | String | 設備別名 | 是 |
品牌 | brand | String | 品牌 | 否 |
產(chǎn)品型號 | productModel | String | 產(chǎn)品型號 | 否 |
分辨率 | resolution | String | 分辨率 | 否 |
IP地址 | ip | String | IP地址 | 否 |
通道號 | channel | String | 通道號 | 否 |
分組名稱 | groupName | String | 分組名稱 | 否 |
播放地址 | url | String | 播放地址 | 否 |
狀態(tài) | status | Enum | 狀態(tài) | 否 |
位置地址 | address | String | 位置地址 | 否 |
位置經(jīng)度 | longitude | Double | 位置經(jīng)度-高德坐標系 | 否 |
位置經(jīng)度 | latitude | Double | 位置經(jīng)度-高德坐標系 | 否 |
備注 | remark | String | 備注 | 否 |
1.9 SI項目下綁定設備
該接口不需要cloudtoken
path | 版本 | 描述 |
/project/device/bind | 1.0.0 | 綁定項目 |
請求參數(shù)
入?yún)⒚Q | 數(shù)據(jù)類型 | 是否必須 | 入?yún)⒚枋?/p> |
|---|---|---|---|
projectId | String | 是 | SI中的項目id |
iotIds | Array | 是 | 設備的iotid列表，["TEHlmHRWktnr0QA1zwOk000000","lAAkfniNdZWECLttFN1h000000"] |
返回結果
參數(shù)名稱 | 數(shù)據(jù)類型 | 參數(shù)描述 |
data | JSON | 無 |
1.10 SI項目下解綁設備
該接口不需要cloudtoken
path | 版本 | 描述 |
/project/device/unbind | 1.0.0 | 解綁項目 |
請求參數(shù)
入?yún)⒚Q | 數(shù)據(jù)類型 | 是否必須 | 入?yún)⒚枋?/p> |
|---|---|---|---|
projectId | String | 是 | SI中的項目id |
iotIds | Array | 是 | 設備的iotid列表，["TEHlmHRWktnr0QA1zwOk000000","lAAkfniNdZWECLttFN1h000000"] |
返回結果
參數(shù)名稱 | 數(shù)據(jù)類型 | 參數(shù)描述 |
data | JSON | 無 |
1.11 修改設備別名
path | 版本 | 描述 |
/solution/community/device/nickname/update | 1.0.0 | 修改設備別名 |
請求參數(shù)
入?yún)⒚Q | 數(shù)據(jù)類型 | 是否必須 | 入?yún)⒚枋?/p> |
deviceIdentity | JsonObject | 是 | 詳見DeviceIdentityDTO |
nickName | String | 是 | 設備別名 |
DeviceIdentityDTO
字段名 | 類型 | 必填 | 備注 |
type | String | 是 | IOT_ID/PK_AND_DN |
iotId | String | 否 | 設備id |
productKey | String | 否 | 產(chǎn)品PK |
deviceName | String | 否 | 產(chǎn)品DN |
返回結果使用通用結果類型，不使用data域。