全部产品

设备管理

更新时间:2020-12-31 14:20

注意:设备请先在应用服务平台添加到项目,再添加到小区

1.1 添加设备到小区

path

版本

描述

/solution/community/paas/device/add

1.0.2

添加设备到小区

请求参数

入参名称

数据类型

是否必须

入参描述

deviceIdentity

JsonObject

详见DeviceIdentityDTO

nickName

String

设备别名

DeviceIdentityDTO

字段名

类型

必填

备注

type

String

IOT_ID/PK_AND_DN

iotId

String

设备id

productKey

String

产品PK

deviceName

String

产品DN

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

1.2 从小区删除设备

path

版本

描述

/solution/community/paas/device/remove

1.0.1

从小区删除设备

请求参数

入参名称

数据类型

是否必须

入参描述

deviceIdentity

JsonObject

详见DeviceIdentityDTO

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

1.3 小区设备列表

path

版本

描述

/solution/community/paas/device/query

1.0.2

小区设备列表

请求参数

入参名称

数据类型

是否必须

入参描述

pageNo

整型

当前页,从1开始

pageSize

整型

每页大小,最大100

categoryKey

字符串

设备的品类。例如梯控设备的品类是ElevatorController

返回结果

字段名

类型

备注

data

JSON

JsonArray 详见DeviceDTO

1.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未激活

categoryName

String

设备所属品类名称

categoryKey

String

设备所属品类key

thingType

String

设备的类型: "VIRTUAL", "WEB", "APP","DEVICE"

lastOnlineTime

String

设备最后上线时间

1.5 查询推流地址

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

该接口不需要cloudtoken

path

版本

描述

/vision/stream/query

2.1.0

查询推流地址

请求参数

入参名称

数据类型

是否必须

入参描述

iotId

字符串

设备id

streamType

整型

流类型,0表示主码流,1表示辅码流

encrypted

布尔

是否加密

encryptType

整型

加密类型,0表示关键帧加密

forceIFrame

布尔

强制I帧

scheme

字符串

协议类型,支持 rtmp/hls/flv

返回结果

参数名称

数据类型

参数描述

data

JSON

视频流

视频流结构

参数名称

数据类型

参数描述

path

字符串

直播地址

decryptKey

JSON

解密密钥

iv

字符串

向量base64值

key

字符串

密钥base64值

1.6 获取录像记录

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

该接口不需要cloudtoken

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

整型

下一页起始时间

1.7 获取历史文件播放地址

获取录像记录的播放地址

该接口不需要cloudtoken

path

版本

描述

/vision/vod/getbyfilename

2.0.0

获取录像记录播放地址

请求参数

入参名称

数据类型

是否必须

入参描述

iotId

字符串

设备ID

fileName

字符串

文件名,录像查询接口返回

返回结果

参数名称

数据类型

参数描述

data

JSON

响应结果,结果请查看下一列

vodUrl

字符串

点播地址,带鉴权信息,无法重复点播使用

1.8 摄像头信息维护

录入接口

https://help.aliyun.com/document_detail/140317.html?spm=a2c4g.11174283.6.656.3eb152d0h4ulQY

API名称

API描述

API Path

API 版本

新增/查询数据

基于已经创建且被授权写入的模型,进行数据的新增。

/data/model/data/insert

/data/model/data/query

0.0.3

模型ID

版本

·VideoDeviceInfo

1.1

属性名称

属性标识符

数据类型

数据描述

是否必须

视频设备Id

deviceId

String

视频设备Id

设备别名

name

String

设备别名

品牌

brand

String

品牌

产品型号

productModel

String

产品型号

分辨率

resolution

String

分辨率

IP地址

ip

String

IP地址

通道号

channel

String

通道号

分组名称

groupName

String

分组名称

播放地址

url

String

播放地址

状态

status

Enum

状态

位置地址

address

String

位置地址

位置经度

longitude

Double

位置经度-高德坐标系

位置经度

latitude

Double

位置经度-高德坐标系

备注

remark

String

备注

1.9 SI项目下绑定设备

该接口不需要cloudtoken

path

版本

描述

/project/device/bind

1.0.0

绑定项目

请求参数

入参名称

数据类型

是否必须

入参描述

projectId

String

SI中的项目id

iotIds

Array

设备的iotid列表,["TEHlmHRWktnr0QA1zwOk000000","lAAkfniNdZWECLttFN1h000000"]

返回结果

参数名称

数据类型

参数描述

data

JSON

1.10 SI项目下解绑设备

该接口不需要cloudtoken

path

版本

描述

/project/device/unbind

1.0.0

解绑项目

请求参数

入参名称

数据类型

是否必须

入参描述

projectId

String

SI中的项目id

iotIds

Array

设备的iotid列表,["TEHlmHRWktnr0QA1zwOk000000","lAAkfniNdZWECLttFN1h000000"]

返回结果

参数名称

数据类型

参数描述

data

JSON

1.11 修改设备别名

path

版本

描述

/solution/community/device/nickname/update

1.0.0

修改设备别名

请求参数

入参名称

数据类型

是否必须

入参描述

deviceIdentity

JsonObject

详见DeviceIdentityDTO

nickName

String

设备别名

DeviceIdentityDTO

字段名

类型

必填

备注

type

String

IOT_ID/PK_AND_DN

iotId

String

设备id

productKey

String

产品PK

deviceName

String

产品DN

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