物联网平台

信锐技术自主研发的多元化、高性能的物联网控制器，集设备统一管理、智能物联策略、便捷基础运维、数据分析系统于一体，精细化的管理设备和人性化的联动设置，满足用户日常需求。

搜本产品

通用

{{item.code}}

IPSIP场景

独立私有云平台

SIC IOTP P 3.7.10.1用户手册

二合一平台

IOTP IW 3.7.10.1用户手册

IOTP IS 3.7.12.4用户手册

安装手册

功能配置

空间大屏

平台管理

开放接口

IOTP 开放 API 文档

视频监控对接

单点登录

物联网单点登录配置指导手册

智能策略

最佳实践

机房哨兵3.0

春蚕校园

基本配置

物联网设备组网与基本配置

其他

设备升级

运维管理

设备登录方法

控制台恢复默认配置

指示灯状态说明

故障案例FAQ

策略联动

告警事件

漏液或烟雾告警看不到日志

平台（控制器）相关

大屏问题

APP体验问题

密钥类问题

使用强制秘钥工具时报错

版本问题

云守护

云守护控制器离线通知

序列号授权

IOT 3.7.6.1版本及以上的序列号含义

IOTP 开放 API 文档

更新时间：2024-09-14

1.产品简介

1.1. 物联网平台

1.2.名词解释

本章主要对文档中相关的名词进行解释

名词	关键字	描述
身份密钥	secret	用于请求接口凭证的密钥参数，泄露会导致安全风险
访问授权	accessToken	调用接口的凭证，每隔两个小时需要重新获取
应		应用主要用来区分不同物联网的应用领域，例如校园应用，机房
用	app	应用，是具体物联网应用的业务操作的容器
空		对应现实设备所处的物理位置空间，用于设备位置的定位索引，
间	space	和设备集中操作控制等业务
硬件	hardware	具体的传感器硬件，一一对应于客户实际购买的传感器，平台业务主要表现在基础的设备接入
设备	device	客户在物联网平台面向的业务操作所对应的基础设备单元，可由一个或者多个传感器硬件组成，用来实现可扩展的业务需求
云守护	cloudGuardian	和云平台相结合的实时告警服务功能，设备智能告警和人工监控告警相结合的告警服务
加工任务	processingTask	对设备数据进行自定义处理的配置任务，个性化图表需要基于该任务进行创建
情景策略	scene	一组动作的集合，可对多种设备，多个设备同时下发指令
巡检策略	inspection	用来巡逻监控不同设备的指定状态是否存在异常的策略
账户分组	group	多个用户的账号集合，用于创建现实用户的组织架构，方便管理和区分
账户	account	用户在平台的唯一标识，用于平台登陆或者设备权限分配时区分不同的个人
授权	authorization	赋予权限的操作，包括授权账号平台的管理员权限，授权门锁或者其他设备的用户操作权限

2. 应用案例

备注：后续案例均参考下表取值

项目	说明
平台URL	200.200.159.81
平台API Token	eb6f7bdddefaba4040be8001ebbb1629
应用名称	我的校园
流程	先获取accessToken ，再进行业务操作

2.1. 获取访问授权

配置开放API

o [平台管理-开放接口-API接口]页面可以开启/关闭该功能，点击“ 眼睛”图标可查看对应值

o API Token ：可正常使用全套API （增、删、改、查权限）

。只读API Token ：只能使用查看类API ，新增、修改、删除、控制类API无权限操作（查看权限）

获取访问授权

URL地址：https://200.200.159.81/iotp/api/open/accessControl/accessToken/get 。请求参数

{

"secret":"eb6f7bdddefaba4040be8001ebbb1629" }

。回复结果

{

"code":0, "data":[

{

"appTypeID":"Classroom", "appTypeName":"智慧校园", "appID":3,

"appName":"我的校园",

"accessToken":"2ca2e136c05cb74919e9c7c328a7553f" "expireIn":7200

} ]

}

2.2.空间管理

应用场景

。第三方应用商整合管理信锐的门禁系统，首次可以通过空间管理接口获取门禁系统的设备空间组织架构，从而进一步获取到各个空间下的设备列表。

创建空间

URL地址：https://200.200.159.81/iotp/api/open/spaceManagement/space/create 。请求参数

{

"accessToken":"2ca2e136c05cb74919e9c7c328a7553f" "spaceParentID": 65,

"spaceName": "C栋" }

。回复结果

{

"code":0,

"data":{

"spaceID":68,

"spaceName":"C栋"

} }

获取空间

URL地址：https://200.200.159.81/iotp/api/open/spaceManagement/space/list 。请求参数

{

"accessToken":"2ca2e136c05cb74919e9c7c328a7553f" "filter": {

"all": true }

}

。回复结果

2.3.设备管理

应用场景

。第三方业务系统可通过设备管理接口，获取设备类型定义信息，查看设备状态以及控制设备

前提条件

。上线设备

。创建虚拟设备

获取设备类型列表

URL地址：https://200.200.159.81/iotp/api/open/deviceManagement/device/type/list 。请求参数

{

"accessToken": "2ca2e136c05cb74919e9c7c328a7553f" "filter": {

"deviceTypeIDs": [

"02f86de2e34087cd73ca4daf26ba1200c"

"deviceTypeNames": [

"*智能门锁*"

"deviceClassification": [

]

} }

。回复结果

获取设备列表

URL地址：https://200.200.159.81/iotp/api/open/deviceManagement/hardware/list 。请求参数

{

"accessToken": "2ca2e136c05cb74919e9c7c328a7553f"

"filter": {

"deviceTypeIDs": [

"02f86de2e34087cd73ca4daf26ba1200c"

。回复结果

控制设备

URL地址：https://200.200.159.81/iotp/api/open/deviceManagement/device/control 。请求参数

{

"accessToken": "2ca2e136c05cb74919e9c7c328a7553f", "filter": {

"all": false,

"deviceTypeID": "02f86de2e34087cd73ca4daf26ba1200c", "deviceIDs": [

"VT1598682961644081117"

] },

"states": [ {

"stateID": "REMOTE_CONTROL_1", "value": 1,

"expireIn": 300 }

"configs": [],

"controlDESC": "上课时间，打开门锁" }

。回复结果

{

"code": 0, "data": [

{

"success": true,

"deviceTypeID": "02f86de2e34087cd73ca4daf26ba1200c", "deviceTypeName": "智能门锁",

"deviceID": "VT1598682961644081117", "deviceName": "D468BA31100009C6",

"result": "成功"

} ]

}

2.4.事件管理

应用场景

。用户想要查看平台应用中设备在一段时间内的告警信息，并进行消警操作

前提条件

。配置联动策略

。触发告警，并产生告警消息

获取告警列表

URL地址：https://200.200.159.81/iotp/api/open/deviceManagement/device/control 。请求参数

{

"accessToken": "2ca2e136c05cb74919e9c7c328a7553f" "filter": {

"all": true },

"positioning": {

"count": 20 }

}

。回复结果

消除告警

URL地址：https://200.200.159.81/iotp/api/open/eventManagement/alarm/deal 。请求参数

{

"accessToken": "accessToken", "filter": {

"all": true }

}

。回复结果

{

"code": 0, "data": [

{

"success": true, "alarmID": 100,

"result": "消除告警成功" }

] }

2.5.数据分析

应用场景

。用户需要设备的原始数据，生成个性化的统计图、趋势图等

前提条件

。上线设备

。配置加工任务

获取设备原始数据列表

URL地址：https://200.200.159.81/iotp/api/open/dataAnalysis/rawData/device/list 。请求参数

{

"accessToken": "2ca2e136c05cb74919e9c7c328a7553f", "filter": {

"deviceTypeID": "02f86de2e34087cd73ca4daf26ba1200c", "timeStart": "2020-08-26 00:00:00",

"timeEnd": "2020-08-29 00:00:00" },

"positioning": { "count": 50

} }

。回复结果

获取加工任务列表

URL地址：https://200.200.159.81/iotp/api/open/dataAnalysis/processingTask/list 。请求参数

{

"accessToken": "2ca2e136c05cb74919e9c7c328a7553f" "filter": {

"all": true },

"paging": {

"offset": 0, "size": 20

} }

。回复结果

获取设备加工数据列表

URL地址：https://200.200.159.81/iotp/api/open/dataAnalysis/processingTask/list 。请求参数

{

"accessToken": "2ca2e136c05cb74919e9c7c328a7553f" "filter": {

"all": true },

"paging": {

"offset": 0, "size": 20

} }

。回复结果

{

"code": 0, "data": {

"paging": {

"nextOffset": 0

"results": [ {

"taskID": 5,

"taskName": "加工任务",

"taskType": "statistic", "description": "",

"state": "",

"dataTypes": [ {

"dataTypeID": "sum",

"dataTypeName": "总和", "unit": ""

}, {

"dataTypeID": "count", "dataTypeName": "数量", "unit": "次"

}, {

"dataTypeID": "average", "dataTypeName": "平均值", "unit": ""

}, {

"dataTypeID": "max",

"dataTypeName": "最大值", "unit": ""

}, {

"dataTypeID": "min",

"dataTypeName": "最小值", "unit": ""

} ],

"dataSources": [ {

"dataSourceID": 1, "deviceTypeID":

"02f86de2e34087cd73ca4daf26ba1200c",

"deviceTypeName": "智能门锁", "stateID": "VOLTAGE_STA_1", "stateName": "电池电量"

} ]

} }

2.6. 智能策略

2.6.1.情景策略

应用场景

。为了用电安全，学校宿舍晚上统一断电，将所有插座设备断电。

配置情景策略

查看情景策略

URL地址：https://200.200.159.81/iotp/api/open/policyMangement/platform/scene/list 。请求参数

{

"accessToken": "2ca2e136c05cb74919e9c7c328a7553f"

"filter": {

"all": false,

"scenePolicyIDs": [ 5,

] },

"paging": {

"offset": 0, "size": 20

} }

。回复结果

执行情景策略

o URL地址： https://200.200.159.81 /iotp/api/open/policyMangement/platform/scene/exe c

。请求参数

{

"accessToken": "2ca2e136c05cb74919e9c7c328a7553f" "scenePolicyID": 2,

"spaceID": 2,

"spaceRecursive": true }

。回复结果

{

"code": 0,

"data": {

"scenePolicyID": 2,

"scenePolicyName": "情景策略", "results": [

{

"deviceTypeID": "0eb1eca07009b61e75ba1a8d77b769426", "deviceTypeName": "门锁1",

"deviceInfos": [ {

"success": true,

"deviceID": "VT1576694286598695771",

"deviceName": "插座1", "result": "控制设备成功"

}, {

"success": true,

"deviceID": "VT1576694286598695771",

"deviceName": "门锁2", "result": "控制设备成功"

} ]

} }

2.6.2.巡检策略

应用场景

用户需要轮询空间下所有设备，查看是否有异常设备需要人工干预处理

配置巡检策略

查看巡检策略

o URL地址： https://200.200.159.81 /iotp/api/open/policyMangement/platform/inspectio n/list

。请求参数

{

"accessToken": "2ca2e136c05cb74919e9c7c328a7553f"

"filter": {

"all": false,

"inspectionPolicyIDs": [ 5,

] },

"paging": {

"offset": 0, "size": 20

} }

。回复结果

{

"code": 0,

"data": {

"scenePolicyID": 2,

"scenePolicyName": "情景策略", "results": [

{

"deviceTypeID": "0eb1eca07009b61e75ba1a8d77b769426", "deviceTypeName": "门锁1",

"deviceInfos": [ {

"success": true,

"deviceID": "VT1576694286598695771",

"deviceName": "插座1", "result": "控制设备成功"

}, {

"success": true,

"deviceID": "VT1576694286598695771",

"deviceName": "门锁2", "result": "控制设备成功"

} ]

} }

执行巡检策略

o URL地址： https://200.200.159.81 /iotp/api/open/policyMangement/platform/inspectio n/exec

。请求参数

{

"accessToken": "2ca2e136c05cb74919e9c7c328a7553f" "inspectionPolicyID": 2,

"spaceID": 2,

"spaceRecursive": true }

。回复结果

{

"code": 0, "data": {

"inspectionID": 5,

"inspectionTime": "2019-11-30 10:12:51", "deviceInfos": [

{

"deviceTypeID": "03351be9e00000028741a888be4f9867d", "deviceTypeName": "智能门锁",

"normalCount": 5,

"abnormalCount": 1, "abnormalList": [

{

"deviceID": "VT1572345594937333666",

"deviceName": "门锁1", "result": "设备离线"

} ]

} }

查看巡检记录

2.7.账户管理

应用场景

。用户需要对使用平台的人员进行管控，需要新增用户或变更用户权限

前提条件

。上线门锁

创建账户分组

URL地址：https://200.200.159.81/iotp/api/open/accountManagement/group/create 。请求参数

{

"accessToken":"2ca2e136c05cb74919e9c7c328a7553f" "groupParentID": 53,

"groupName": "新锐中学" }

。回复结果

{

"code": 0, "data": {

"groupID": 54,

"groupName": "A栋" }

}

查看账户分组

URL地址：https://200.200.159.81/iotp/api/open/accountManagement/group/list 。请求参数

{

"accessToken":"2ca2e136c05cb74919e9c7c328a7553f" "filter": {

"all": false,

"accountType": "local", "groupIDs": [

] }

}

。回复结果

创建账户

URL地址：https://200.200.159.81/iotp/api/open/accountManagement/account/create 。请求参数

{

"accessToken": "2ca2e136c05cb74919e9c7c328a7553f"

"accountName": "zhangsan", "roleType": "appAdmin",

"groupID": 5,

"description": "超级管理员", "mobile": "13500000000",

"enable": true,

"authorizations": [ {

"appID": 5,

"spaceIDs": [

] }

"configs": [ {

"appTypeID": "entranceGuard",

"items": [ {

"key": "sundray.card", "value": "AABBCCDD"

}, {

"key": "sundray.password", "value": "730920"

} ]

}

。回复结果

{

"code": 0, "data": {

"accountID": 2,

"accountName": "A栋", "result": "新增账户成功"

} }

查看账户

URL地址：https://200.200.159.81/iotp/api/open/accountManagement/account/list 。请求参数

{

"accessToken": "2ca2e136c05cb74919e9c7c328a7553f" "filter": {

"accountType": "local", "accountIDs": [

] },

"paging": {

"offset": 0, "size": 20

} }

。回复结果

将账户授权到门禁设备

o URL地址： https://200.200.159.81 /iotp/api/open/accountManagement/authorization/se

。请求参数

。回复结果

{

"code": 0, "data": [

{

"success": true,

"deviceTypeID": "0fd0324430000002af1314589f9a7534c", "deviceID": "VT1574857882979158901",

"accountID": 1,

"result": "新增授权关系" },

{

"success": true,

"deviceTypeID": "0fd0324430000002af1314589f9a7534c", "deviceID": "VT1574857882979158902",

"accountID": 1,

"result": "修改授权关系有效期" }

] }

验证授权成功

。使用授权账号的门禁卡与密码开启智能门锁，开锁成功则表示授权成功

2.8.门禁预约

应用场景

。用户周六有实验课，需要周六使用实验室，需要预约授权实验室门禁权限。

前提条件

。上线门锁

预约门禁

o URL地址： https://200.200.159.81 /iotp/api/open/application/entranceGuard/appointme nt/make

。请求参数

。回复结果

{

"code": 0 }

验证预约成功

。使用授权账号的密码开启智能门锁，开锁成功，且到授权期限结束，临时密码无法开锁，表示授权成功

2.9. 设备数据转发

应用场景

。用户有自己的办公OA ，需要将设备数据转发到OA系统。

前提条件

。设备接入

配置【设备数据转发】功能

接收设备数据

。请求参数

{

"token": "dataToken", "data": [

{

"type_name": "LoRaPlug",

"device_id": "GEK6510017", "time_stamp": 1523603923, "next_report": 60,

"state": {

"DEV_BEEP_STA": "0", "DEV_CAPACITY": "0", "DEV_CURRENT": "1",

"DEV_GATEWAY": "GFG7380303",

"DEV_LED_STA": "0",

"DEV_LORADBM": "-32",

"DEV_PLATFORM_REJ": "0", "DEV_POLICY_REJ": "0",

"DEV_POWER": "51",

"DEV_SWITCH_STA": "1", "DEV_VOLRAGE": "210"

} }

] }

2.10. 告警数据转发

应用场景

。用户有自己的即时通信平台，需要将告警数据转发到即时通信系统

前提条件

。配置联动策略-条件触发-告警

配置【告警数据转发】功能

接收告警数据

{

"token": "alarmToken", "type": "alarm",

"data": {

"id": 12,

"alarm_mode": "DEV_SWITCH_STA_1", "alarm_rank": "4",

"content": "[插座][插座]开关[当前值关闭 ]", "device_id": "VT1555887465420831580",

"device_name": "插座",

"notify_Detail": "{\"app\":[\"admin\"],\"sms\":[\"admin\"]}", "policy_id": 5,

"policy_name": "Sundray_IOT_值域告警", "space_path": "/15/",

"space_path_name": "Sundray_IOT",

"type_id": "025fb622f1f87ed57d81517f642943ff7", "type_name": "插座"

} }

3开发指南

3.1.请求地址

字段	说明
通信协议	所有接口均通过 HTTPS 进行通信，提供高安全性的通信通道
域名	物联网平台的访问地址
固定前缀	固定前缀；保持一致即可
资源	操作的物联网平台对象；通过层次结构进行描述
动作	对资源的操作方式

3.2.请求结构

请求方法： POST （当前支持此请求方法）

字符编码：均使用UTF-8编码

3.3. 回复结构

正确请求返回示例：

{

"code": 0,

"data": {} }

正确请求说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	all	返回结果； data字段的类型详见各个接口的使用方法

错误请求返回示例：

{

"code": 1000,

"errmsg" : "请求参数错误", "data": {}

}

错误请求说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
errmsg	string	错误描述；开发者需根据code是否为0判断是否调用成功；而 errmsg仅作参考，后续可能会有变动，因此不可作为是否调用成功的判据
data	all	返回结果； data字段的类型详见各个接口的使用方法

3.4.公共参数

3.4.1.accessToken

1. 第三方服务的访问授权；请求其他接口时，需要在请求中携带此参数； accessToken的获取方式，请查看此处

2. accessToken会因多种原因提前失效；当请求接收到code ：2002的返回值时，应重新获取 accessToken ，并重试请求；

3.4.2.code

结果码；为0时表示请求成功，非0时表示请求失败

3.4.3.data

. 返回结果； data字段的类型详见各个接口的使用方法

3.4.4.errmsg

. 错误描述；开发者需根据code是否为0判断是否调用成功；而errmsg仅作参考，后续可能会有变动，因此不可作为是否调用成功的判据

3.4.5. filter

1. 筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为 “与”的关系，同类型的筛选条件之间为“或”的关系

2. 当筛选结果为空时，请求依旧会返回code ：0 ；用户可根据返回的data字段，来确定请求的影响范围

3.4.6.positioning

1. maxID ：最大ID ；返回结果中的ID值均小于maxID ；为空表示不做限制

2. sinceID ：最小ID ；返回结果中的ID值均大于sinceID ；为空表示不做限制

3. count ：期望的结果数量；返回结果中将包含不超过指定数量的数据

4. left ：剩余结果数量；在maxID和sinceID的限定范围内，剩余的结果数量

5. 使用说明：

1. 首次获取时，可将maxID参数和sinceID参数的值设置为0 ，size参数设置为期望的结果数量；请求将返回left参数，以及不超过size数量的结果列表

2. 当left参数不为0时，可将maxID参数的值设置为结果列表中， id的最小值减1 （即返回结果的 id列表为10、9、8时，可将maxID参数的值设置为7），继续请求剩余数据

3. 如需获取最新数据，可将sinceID参数的值设置为已获取结果的id最大值（即当已获取结果的最大id号为10时，可将sinceID参数的值设置为10），尝试请求最新数据

4. 如果未获取的最新数据较多，可参考第二点和第三点，同时设置maxID参数和sinceID参数，进行多次请求，直到获取到所有数据

3.4.7.paging

1. offset ：偏移位置；从结果列表的该偏移位置开始返回，为0表示从第一个结果开始返回

2. size ：期望的结果数量；返回结果中将包含不超过指定数量的数据

3. nextOffset ：下一页的偏移量；为0表示没有剩余数据

4. 使用说明：

1. 首次获取时，可将offset参数设置为0 ，size参数设置为期望的结果数量；请求将返回 nextOffset参数，以及不超过size数量的结果列表；

2. 当nextOffset参数不为0时，可将offset参数的值设置为nextOffset参数的值，继续请求下一页的数据

3.5.兼容性约定

3.5.1.说明

1. 随着物联网平台的不断迭代升级，开放接口服务也会不断更新完善

2. 为了确保开放接口服务的更新完善，不会对现有的客户端程序造成影响，特进行以下约定：

当发生[向后兼容的（非重大）更改]时，将不会另行通知，客户端程序应为此类变更提前做好兼容处理

3.5.2.向后兼容的（非重大）更改

1. 向开放接口服务添加新的API接口

2. 向请求消息中添加新的字段

3. 向响应消息中添加新的字段

4. 向枚举中添加新的枚举项

3.6.API列表

3.6.1. 访问授权

API	描述
/accessControl/accessToken/get	获取第三方服务的访问授权

3.6.2. 应用管理

API	描述
/applicationManagement/type/list	获取应用类型列表
/applicationManagement/app/list	获取应用列表

3.6.3.空间管理

API	描述
/spaceManagement/space/list	获取空间列表
/spaceManagement/space/create	新建空间
/spaceManagement/space/rename	重命名空间
/spaceManagement/space/move	移动空间
/spaceManagement/space/delete	删除空间

3.6.4.设备管理

API	描述
/deviceManagement/hardware/label/list	获取硬件类型标签列表
/deviceManagement/hardware/type/list	获取硬件类型列表
/deviceManagement/hardware/list	获取硬件列表
/deviceManagement/hardware/update	编辑硬件
/deviceManagement/hardware/control	控制硬件
/deviceManagement/hardware/cancel	撤销控制硬件
/deviceManagement/device/label/list	获取设备标签列表
/deviceManagement/device/label/create	新增设备标签
/deviceManagement/device/label/update	编辑设备标签
/deviceManagement/device/label/delete	删除设备标签
/deviceManagement/device/type/list	获取设备类型列表
/deviceManagement/device/list	获取设备列表
/deviceManagement/device/update	编辑设备
/deviceManagement/device/control	控制设备
/deviceManagement/device/cancel	撤销控制设备

3.6.5.事件管理

API	描述
/eventManagement/alarm/list	获取告警列表
/eventManagement/alarm/confirm	确认告警
/eventManagement/alarm/deal	消除告警
/eventManagement/inspection/list	获取巡检记录列表
/eventManagement/cloudGuardian/list	获取云守护告警列表
/eventManagement/deviceOperation/list	获取设备操作列表
/eventManagement/unlockingRecord/list	获取开锁记录列表
/eventManagement/vedioRecord/list	获取视频记录列表

3.6.6. 数据分析

API	描述
/dataAnalysis/rawData/hardware/list	获取硬件数据列表
/dataAnalysis/rawData/device/list	获取设备数据列表
/dataAnalysis/processingTask/list	获取加工任务列表
/dataAnalysis/processedData/device/list	获取设备加工数据列表
/dataAnalysis/processedData/space/list	获取空间加工数据列表

3.6.7.智能策略

API	描述
/policyMangement/edge/gateway/list	获取网关边缘策略列表
/policyMangement/edge/terminal/list	获取终端边缘策略列表
/policyMangement/platform/scene/list	获取情景策略列表
/policyMangement/platform/scene/exec	执行情景策略
/policyMangement/platform/timing/list	获取定时策略列表
/policyMangement/platform/linkage/list	获取联动策略列表
/policyMangement/platform/inspection/list	获取巡检策略列表
/policyMangement/platform/inspection/exec	执行巡检策略
/policyMangement/platform/alarm/range/list	获取值域告警列表
/policyMangement/platform/alarm/policy/list	获取策略告警列表
/policyMangement/platform/cloudGuardian/emergencyContact/get	获取紧急联系人
/policyMangement/platform/cloudGuardian/emergencyContact/set	设置紧急联系人
/policyMangement/platform/cloudGuardian/list	获取云守护策略列表

3.6.8.账户管理

API	描述
/accountManagement/group/list	获取账户分组列表
/accountManagement/group/create	新增账户分组
/accountManagement/group/rename	重命名分组
/accountManagement/group/move	移动分组
/accountManagement/group/delete	删除账户分组
/accountManagement/account/list	获取账户列表
/accountManagement/account/create	新增账户
/accountManagement/account/update	编辑账户
/accountManagement/account/delete	删除账户
/accountManagement/authorization/list	获取授权关系列表
/accountManagement/authorization/set	设置授权关系
/accountManagement/authorization/unset	取消授权

3.6.9.平台管理

暂无

3.6.10.系统维护

暂无

3.6.11.行业应用

API	描述
/application/entranceGuard/appointment/make	预约
/application/entranceGuard/appointment/cancel	取消预约

4.开放接口

4.1. 访问授权

4.1.1. 接口授权

4.1.1.1. 获取第三方服务的访问授权

. 请求地址： https://$host/iotp/api/open/accessControl/accessToken/get

. 功能说明：该API用于使用身份密钥(secret)获取第三方服务的访问授权(accessToken) 请求示例：

{

"secret": "secret" }

请求说明：

字段名

必须

类型

说明

secret

是

string

第三方服务的身份密钥；可以在[平台管理-开放接口-API接口] 页面查看

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- appTypeID	string	应用类型ID ，应用类型的唯一标志
- appTypeName	string	应用类型名称
- appID	string	应用ID ；应用的唯一标志
- appName	string	应用名称
- accessToken	string	第三方服务的访问授权；请求其他接口时，需要在请求中携带此参数
- expireIn	number	accessToken的有效期（单位：秒）

错误原因：

错误码	说明
2002	开放接口服务未开启
2003	secret错误

4.2.应用管理

4.2.1. 应用类型

4.2.1.1. 获取应用类型列表

. 请求地址： https://$host/iotp/api/open/applicationManagement/type/list

功能说明：该API用于获取应用类型列表请求示例：

{

"accessToken": "accessToken",

"filter": {

"all": true, "appTypes": [

"app",

"system"

] }

}

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API 作用于全部对象时，需要显式设置为true
appTypes	否	string[]	应用类型筛选参数；将作用于指定的应用类型；取值范围为"app"和"system" ，其中"app"代表应用类型，"system"代表子系统类型；不指定该参数时，将作用于所有类型

返回示例：

{

"code": 0, "data": {

"apps": [ {

"appTypeID": "classroom", "appTypeName": "校园应用", "description": "校园应用"

} ],

"systems": [ {

"systemTypeID": "alarm",

"systemTypeName": "告警系统", "description": "告警系统"

} ]

} }

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- apps	object[]	应用类型列表
- - appTypeID	string	应用类型ID ，应用类型的唯一标志
- - appTypeName	string	应用类型名称
- - description	string	应用类型描述
- systems	object[]	子系统类型列表
- - systemTypeID	string	子系统类型ID ，子系统类型的唯一标志
- - systemTypeName	string	子系统类型名称
- - description	string	子系统类型描述

错误原因：暂无

4.2.2. 应用

4.2.2.1.获取应用列表

· 请求地址： https://$host/iotp/api/open/applicationManagement/app/list

功能说明：该API用于获取应用列表请求示例：

{

"accessToken": "accessToken", "filter": {

"all": true,

"appTypeIDs": [

"classroom", "machineroom"

"appIDs": [ 1,

"appNames": [ "春蚕校园", "机房哨兵*"

]

} }

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该 API作用于全部对象时，需要显式设置为true
- appTypeIDs	否	string[]	应用类型ID ，应用类型的唯一标志
- appIDs	否	number[]	应用ID ；应用的唯一标志
- appNames	否	string[]	应用名称

返回示例：

{

"code": 0, "data": [

{

"appTypeID": "Classroom", "appID": 3,

"appName": "智慧校园",

"description": "智慧校园", "background":

"/SPM/images/Application/application/Classroom_3.png", "systems": [

{

"systemTypeID": "alarmSystem" }

] }

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object[]	返回结果
- - appTypeID	string	应用类型ID ，应用类型的唯一标志
- - appID	number	应用ID ；应用的唯一标志
- - appName	string	应用名称
- - description	string	应用类型描述
- systems	object[]	子系统类型列表
- - systemTypeID	string	子系统类型ID ，子系统类型的唯一标志

错误原因：暂无

4.3.空间管理

4.3.1. 空间

4.3.1.1. 获取空间列表

. 请求地址： https://$host/iotp/api/open/spaceManagement/space/list

功能说明：该API用于获取空间列表请求示例：

{

"accessToken":"accessToken",

"filter": {

"all": true, "spaceIDs": [

"spaceNames": [ "春蚕校园", "机房哨兵*"

"spaceRecursive": true }

}

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为 “与”的关系，同类型的筛选条件之间为“或”的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为 true
- spaceIDs	否	number[]	空间ID ；空间的唯一标志
- spaceNames	否	string[]	空间名称
- spaceRecursive	否	boolen	空间递归查找标志；为true时将作用于指定空间及其子空间；不指定或为false时，将只作用于指定空间

返回示例：

{

"code": 0,

"data": [ {

"spaceID": 1,

"spaceParentID": 0,

"spaceName": "智慧空间", "spacePath": "/1"

}, {

"spaceID": 2,

"spaceParentID": 1,

"spaceName": "智慧空间", "spacePath": "/1/2"

} ]

}

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object[]	返回结果
- spaceID	number	空间ID ；空间的唯一标志
- spaceParentID	number	父空间ID ；空间的唯一标志
- spaceName	string	空间名称
- spacePath	string	空间路径；由空间ID(spaceID)和斜杠(/)分隔符组成；最后一个ID为当前空间ID

错误原因：暂无

4.3.1.2. 新建空间

. 请求地址： https://$host/iotp/api/open/spaceManagement/space/create

功能说明：该API用于新建空间请求示例：

{

"accessToken":"accessToken", "spaceParentID": 1,

"spaceName": "A栋" }

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
spaceParentID	是	number	父空间ID ；空间的唯一标志
spaceName	是	string	空间名称

返回示例：

{

"code": 0, "data": {

"spaceID": 2,

"spaceName": "A栋" }

}

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
spaceID	number	空间ID ；空间的唯一标志
spaceName	string	空间名称

错误原因：暂无

4.3.1.3. 重命名空间

· 请求地址： https://$host/iotp/api/open/spaceManagement/space/rename

功能说明：该API用于重命名空间，支持批量操作请求示例：

{

"accessToken": "accessToken", "filter": {

"spaceIDs": [ 2,

] },

"spaceName": "A栋" }

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- spaceIDs	是	number[]	空间ID ；空间的唯一标志
spaceName	是	string	空间名称

返回示例：

{

"code": 0, "data": [

{

"success": true, "spaceID": 2,

"spaceName": "A栋",

"result": "重命名空间成功" }

] }

{

"code": 2001, "data": [

{

"success": false, "spaceID": 2,

"spaceName": "A栋",

"result": "存在另一个同名的空间" }

] }

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object[]	返回结果
- success	boolen	结果标志；为true时表示请求成功，为false时表示请求失败
- spaceID	number	空间ID ；空间的唯一标志
- spaceName	string	空间名称
- result	string	结果的详细说明

错误原因：暂无

4.3.1.4. 移动空间

· 请求地址： https://$host/iotp/api/open/spaceManagement/space/move

功能说明：该API用于移动空间，支持批量操作请求示例：

{

"accessToken": "accessToken", "filter": {

"spaceIDs": [ 2,

] },

"spaceParentID": 1 }

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为 “与”的关系，同类型的筛选条件之间为“或”的关系
- spaceIDs	是	number[]	空间ID ；空间的唯一标志
spaceParentID	是	number	父空间ID ；空间的唯一标志

返回示例：

{

"code": 0, "data": [

{

"success": true, "spaceID": 2,

"spaceName": "A栋",

"result": "移动空间成功" }

] }

{

"code": 2001, "data": [

{

"success": false, "spaceID": 2,

"spaceName": "A栋",

"result": "存在另一个同名的空间" }

] }

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object[]	返回结果
- success	boolen	结果标志；为true时表示请求成功，为false时表示请求失败
- spaceID	number	空间ID ；空间的唯一标志
- spaceName	string	空间名称
- result	string	结果的详细说明

错误原因：暂无

4.3.1.5. 删除空间

· 请求地址： https://$host/iotp/api/open/spaceManagement/space/delete

功能说明：该API用于删除空间，支持批量操作请求示例：

{

"accessToken": "accessToken", "filter": {

"spaceIDs": [

] }

}

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	string	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
spaceIDs	是	number[]	空间ID ；空间的唯一标志

返回示例：

{

"code": 0, "data": [

{

"success": true, "spaceID": 2,

"spaceName": "A栋",

"result": "删除空间成功" }

] }

{

"code": 2001,

"errmsg": "删除空间失败", "data": [

{

"success": false, "spaceID": 2,

"spaceName": "A栋",

"result": "空间下存在硬件或设备" }

] }

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
errmsg	string	错误描述；开发者需根据code是否为0判断是否调用成功；而 errmsg仅作参考，后续可能会有变动，因此不可作为是否调用成功的判据
data	object[]	返回结果
- success	boolen	结果标志；为true时表示请求成功，为false时表示请求失败
- spaceID	number	空间ID ；空间的唯一标志
- spaceName	string	空间名称
- result	string	结果的详细说明

错误原因：暂无

4.4.设备管理

4.4.1.硬件

4.4.1.1.标签

4.4.1.1.1. 获取硬件类型标签列表

· 请求地址： https://$host/iotp/api/open/deviceManagement/hardware/label/list

功能说明：该API用于获取硬件类型的标签列表请求示例：

{

"accessToken":"accessToken" }

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权

返回示例：

{

"code": 0, "data": [

{

"labelName": "光照强度" }

] }

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object[]	返回结果
labelName	string	标签名称

错误原因：暂无

4.4.1.2.类型

4.4.1.2.1. 获取硬件类型列表

. 请求地址： https://$host/iotp/api/open/deviceManagement/hardware/type/list

功能说明：该API用于获取硬件类型列表请求示例：

{

"accessToken

"fields": [ "info", "states" "configs

": "accessToken",

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
fields	否	string[]	结果域；指定返回结果中包含的内容；取值范围为"info","states"和"configs" ；其中"info"表示基本信息， "states"表示状态列表，"configs"表示配置列表
- filter	否	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为 “或”的关系
- - all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为true
- - hardwareTypeIDs	否	string[]	硬件类型ID ；硬件类型的唯一标志
- - hardwareTypeNames	否	string[]	硬件类型名称
- - labelNames	否	string[]	标签名称
- - manufactoryTypes	否	string[]	生产厂家类型；有"sundray"和"thirdparty"两种；其中"sundray"表示生产厂家为信锐，"thirdparty"表示生产厂家为第三方]

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object[]	返回结果
- hardwareTypeID	string	硬件类型ID ；硬件类型的唯一标志
- info	object	硬件类型的基础信息
- - hardwareTypeName	string	硬件类型名称
- - icon	string	图标
- - description	string	描述
- - model	string	型号
- - manufactory	string	生产厂家
- - accessWay	string	接入方式
- - powerSupplyMode	string	供电方式
- - labelNames	string[]	标签名称
- states	object[]	状态列表
- - stateID	string	状态ID ；状态的唯一标志
- - stateName	string	状态名称
- - unit	string	单位
- - valueType	string	取值类型；有"int","float","enum","string"四种；其中"int"表示整型， "float"表示浮点型， "enum"表示枚举型， "string"表示字符串类型
- - valueRange	object	取值范围
- - - min	number	最小值；当valueType的值为"int"或"float"时有效
- - - max	number	最大值；当valueType的值为"int"或"float"时有效
- - - decimal	number	小数位；当valueType的值为"float"时有效
- - - regexp	string	正则表达式；当valueType的值为"string"时有效
- - controllable	boolen	控制标志；为true时表示该状态可以控制，为false时表示该状态不可控制；
- configs	object[]	配置列表
- - configID	string	配置ID ；配置的唯一标志
- - configName	string	配置名称
- - unit	string	单位

字段名	类型	说明
- - valueType	string	取值类型；有"int","float","enum","string"四种；其中"int"表示整型， "float"表示浮点型， "enum"表示枚举型， "string"表示字符串类型
- - valueRange	object	取值范围
- - - min	number	最小值；当valueType的值为"int"或"float"时有效
- - - max	number	最大值；当valueType的值为"int"或"float"时有效
- - - decimal	number	小数位；当valueType的值为"float"时有效
- - - regexp	string	正则表达式；当valueType的值为"string"时有效
- - controllable	boolen	控制标志；为true时表示该配置可以控制，为false时表示该配置不可控制；

错误原因：暂无

4.4.1.3. 获取硬件列表

· 请求地址： https://$host/iotp/api/open/deviceManagement/hardware/list

功能说明：该API用于获取硬件列表请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
fields	否	string[]	结果域；指定返回结果中包含的内容；取值范围为"info","states"和"configs" ；其中"info"表示基本信息， "states"表示状态列表， "configs"表示配置列表
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为true
- hardwareClassifications	否	string[]	硬件类型分类；有"gateway"和"terminal"两种；"gateway"表示网关硬件，"terminal"表示终端硬件
- hardwareTypeIDs	否	string[]	硬件类型ID ；硬件类型的唯一标志
- hardwareTypeNames	否	string[]	硬件类型名称
- hardwareIDs	否	string[]	硬件ID ；硬件的唯一标志
- hardwareNames	否	string[]	硬件名称
- hardwareStatus	否	string[]	硬件状态；有"online"和"offline"两种；其中"online"表示在线， "offline"表示离线
- spaceIDs	否	number[]	空间ID ；空间的唯一标志
- spaceNames	否	string[]	空间名称
- spaceRecursive	否	boolen	空间递归查找标志；为true时将作用于指定空间及其子空间；不指定或为false 时，将只作用于指定空间
order	否	object	排序参数；为空则按硬件名称顺序排序
- field	否	string	排序作用域；有"info"和"state"两种；其中"info"表示按基本信息排序， "state"表示按状态值排序
- key	否	string	排序键；当field字段的值为"info"时，取值为info字段的各个子项的字段名；当 field字段的值为"state"时，取值为 stateID

字段名	必须	类型	说明
- orderBy	否	string	排序顺序；有"asc"和"desc"两种；其中"asc"表示顺序排序， "desc"表示逆序排序
paging	否	object	分页参数；为空表示返回所有结果
- offset	否	number	偏移位置；从结果列表的该偏移位置开始返回，为0表示从第一个结果开始返回
- size	否	number	期望的结果数量；返回结果中将包含不超过指定数量的数据

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- paging	object	分页参数
- - nextOffset	number	下一页的偏移量；为0表示没有剩余数据
- results	object[]	硬件列表
- - hardwareTypeID	string	硬件类型ID ；硬件类型的唯一标志
- - hardwareID	string	硬件ID ；硬件的唯一标志
- - info	object	硬件的基础信息
- - - spaceID	number	空间ID ；空间的唯一标志
- - - spaceName	string	空间名称
- - - hardwareTypeName	string	硬件类型名称
- - - hardwareName	string	硬件名称
- - - hardwareStatus	string	硬件状态；有"online"和"offline"两种；其中"online"表示在线， "offline"表示离线
- - - statusDescription	string	硬件状态描述；有"在线"和"离线"两种
- - - softwareVersion	string	软件版本号
- - - hardwareVersion	string	硬件版本号
- - - onlineDuration	number	上线时间距离当前时间的时间间隔；单位为秒；
- - - onlineTime	string	上线时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- - - reportDuration	number	最近上报时间距离当前时间的时间间隔；单位为秒；
- - - reportTime	string	最近上报时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- - states	object[]	状态列表
- - - stateID	string	状态ID ；状态的唯一标志
- - - reported	all	设备上报的状态值
- - - desired	all	设备期望的状态值
- - configs	object[]	配置列表
- - - configID	string	配置ID ；配置的唯一标志
- - - reported	all	设备上报的配置值

字段名	类型	说明
- - - desired	all	设备期望的配置值

错误原因：

错误码	说明
code	number

4.4.1.4. 编辑硬件

. 请求地址： https://$host/iotp/api/open/deviceManagement/hardware/update

功能说明：该API用于重命名和移动硬件,支持批量操作请求示例：

{

"accessToken": "accessToken", "filter": {

"all": true,

"hardwareClassifications": [

"gateway", "terminal"

"hardwareTypeIDs": [

"fd0324430000002af1314589f9a7534c"

"hardwareIDs": [ "*GAK*",

"GBK0000001"

"hardwareNames": [

"*智能插座*"

"hardwareStatus": [ "online",

"offline"

"spaceIDs": [

"spaceNames": [

"*A栋*"

"spaceRecursive": true },

"info": {

"spaceID": 1001,

"hardwareName": "GIK8190083" }

}

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为true
- hardwareClassifications	否	string[]	硬件类型分类；有"gateway"和"terminal"两种；"gateway"表示网关硬件，"terminal"表示终端硬件
- hardwareTypeIDs	否	string[]	硬件类型ID ；硬件类型的唯一标志
- hardwareIDs	否	string[]	硬件ID ；硬件的唯一标志
- hardwareNames	否	string[]	硬件名称
- hardwareStatus	否	string[]	硬件状态；有"online"和"offline"两种；其中"online"表示在线， "offline"表示离线
- spaceIDs	否	number[]	空间ID ；空间的唯一标志
- spaceNames	否	string[]	空间名称
- spaceRecursive	否	boolen	空间递归查找标志；为true时将作用于指定空间及其子空间；不指定或为false 时，将只作用于指定空间
info	是	object	基本信息
spaceID	否	string	空间ID ；空间的唯一标志
hardwareName	否	string	硬件名称

返回示例：

{

"code": 0, "data": [

{

"success": true,

"hardwareTypeID": "fd0324430000002af1314589f9a7534c",

"hardwareTypeName": "空调面板", "hardwareID": "GIK8190083",

"hardwareName": "GIK8190083", "result": "编辑成功"

} ]

}

{

"code": 2001,

"errmsg": "编辑硬件失败", "data": [

{

"success": false,

"hardwareTypeID": "fd0324430000002af1314589f9a7534c",

"hardwareTypeName": "智能插座", "hardwareID": "GEK0000001",

"hardwareName": "GEK0000001",

"result": "空间下存在相同的硬件名称" }

] }

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
errmsg	string	错误描述；开发者需根据code是否为0判断是否调用成功；而errmsg仅作参考，后续可能会有变动，因此不可作为是否调用成功的判据
data	object[]	返回结果
- success	boolen	结果标志；为true时表示请求成功，为false时表示请求失败
- hardwareTypeID	string	硬件类型ID ；硬件类型的唯一标志
- hardwareTypeName	string	硬件类型名称
- hardwareID	string	硬件ID ；硬件的唯一标志
- hardwareName	string	硬件名称
- result	string	结果的详细说明

错误原因：

错误码	说明
code	number

4.4.1.5. 控制硬件

. 请求地址： https://$host/iotp/api/open/deviceManagement/hardware/control

功能说明：该API用于控制硬件，支持批量操作请求示例：

{

"accessToken": "accessToken", "filter": {

"all": true,

"hardwareTypeID": "fd0324430000002af1314589f9a7534c", "hardwareTypeName": "智能插座",

"hardwareIDs": [ "*GAK*",

"GBK0000001"

"hardwareNames": [

"*智能插座*"

"hardwareStatus": [ "online",

"offline"

"spaceIDs": [

"spaceNames": [

"*A栋*"

"spaceRecursive": true },

"states": [ {

"stateID": "DEV_SWITCH_STA", "value": 1,

"expireIn": 300 }

"configs": [ {

"configID": "DEV_CON_DELAY_POWER_FLAG", "value": 1

} ]

}

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为true
- hardwareTypeID	否	string	硬件类型ID ；硬件类型的唯一标志
- hardwareTypeName	否	string	硬件类型名称
- hardwareIDs	否	string[]	硬件ID ；硬件的唯一标志
- hardwareNames	否	string[]	硬件名称
- hardwareStatus	否	string[]	硬件状态；有"online"和"offline"两种；其中"online"表示在线， "offline"表示离线
- spaceIDs	否	number[]	空间ID ；空间的唯一标志
- spaceNames	否	string[]	空间名称
- spaceRecursive	否	boolen	空间递归查找标志；为true时将作用于指定空间及其子空间；不指定或为false时，将只作用于指定空间
states	否	object[]	状态列表
- stateID	是	string	状态ID ；状态的唯一标志
- value	是	all	状态值
- expireIn	否	number	过期时间；若硬件未能在过期时间之前完成状态同步，则控制命令失效；单位为秒；
configs	否	object[]	配置列表
- configID	是	string	配置ID ；配置的唯一标志
- value	是	all	配置值

返回示例：

{

"code": 0, "data": [

{

"success": true,

"hardwareTypeID": "fd0324430000002af1314589f9a7534c",

"hardwareTypeName": "智能插座", "hardwareID": "GEK0000001",

"hardwareName": "GEK0000001", "result": "控制硬件成功"

} ]

}

{

"code": 2001,

"errmsg": "控制硬件失败", "data": [

{

"success": false,

"hardwareTypeID": "fd0324430000002af1314589f9a7534c",

"hardwareTypeName": "智能插座", "hardwareID": "GEK0000001",

"hardwareName": "GEK0000001", "result": "硬件不存在"

}, {

"success": true,

"hardwareTypeID": "fd0324430000002af1314589f9a7534c",

"hardwareTypeName": "智能插座", "hardwareID": "GEK0000002",

"hardwareName": "GEK0000002", "result": "控制硬件成功"

}

] }

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
errmsg	string	错误描述；开发者需根据code是否为0判断是否调用成功；而errmsg仅作参考，后续可能会有变动，因此不可作为是否调用成功的判据
data	object[]	返回结果
- success	boolen	结果标志；为true时表示请求成功，为false时表示请求失败
- hardwareTypeID	string	硬件类型ID ；硬件类型的唯一标志
- hardwareTypeName	string	硬件类型名称
- hardwareID	string	硬件ID ；硬件的唯一标志
- hardwareName	string	硬件名称
- result	string	结果的详细说明

错误原因：

错误码	说明
code	number

4.4.1.6. 撤销控制硬件

. 请求地址： https://$host/iotp/api/open/deviceManagement/hardware/cancel

功能说明：该API用于撤销硬件的控制命令，支持批量操作请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为true
- hardwareTypeID	否	string	硬件类型ID ；硬件类型的唯一标志
- hardwareTypeName	否	string	硬件类型名称
- hardwareIDs	否	string[]	硬件ID ；硬件的唯一标志
- hardwareNames	否	string[]	硬件名称
- hardwareStatus	否	string[]	硬件状态；有"online"和"offline"两种；其中"online"表示在线， "offline"表示离线
- spaceIDs	否	number[]	空间ID ；空间的唯一标志
- spaceNames	否	string[]	空间名称
- spaceRecursive	否	boolen	空间递归查找标志；为true时将作用于指定空间及其子空间；不指定或为false时，将只作用于指定空间
states	否	object[]	状态列表
- stateID	是	string	状态ID ；状态的唯一标志

返回示例：

{

"code": 0, "data": [

{

"success": true,

"hardwareTypeID": "fd0324430000002af1314589f9a7534c",

"hardwareTypeName": "智能插座", "hardwareID": "GEK0000001",

"hardwareName": "GEK0000001", "result": "撤销控制成功"

} ]

}

{

"code": 2001,

"errmsg": "撤销控制失败", "data": [

{

"success": false,

"hardwareTypeID": "fd0324430000002af1314589f9a7534c",

"hardwareTypeName": "智能插座", "hardwareID": "GEK0000001",

"hardwareName": "GEK0000001", "result": "硬件不存在"

}, {

"success": true,

"hardwareTypeID": "fd0324430000002af1314589f9a7534c",

"hardwareTypeName": "智能插座", "hardwareID": "GEK0000002",

"hardwareName": "GEK0000002", "result": "撤销控制成功"

}

] }

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
errmsg	string	错误描述；开发者需根据code是否为0判断是否调用成功；而errmsg仅作参考，后续可能会有变动，因此不可作为是否调用成功的判据
data	object[]	返回结果
- success	boolen	结果标志；为true时表示请求成功，为false时表示请求失败
- hardwareTypeID	string	硬件类型ID ；硬件类型的唯一标志
- hardwareTypeName	string	硬件类型名称
- hardwareID	string	硬件ID ；硬件的唯一标志
- hardwareName	string	硬件名称
- result	string	结果的详细说明

错误原因：

错误码	说明
code	number

4.4.2.设备

4.4.2.1. 标签

4.4.2.1.1. 获取设备标签列表

. 请求地址： https://$host/iotp/api/open/deviceManagement/device/label/list

功能说明：该API用于获取设备标签列表请求示例：

{

"accessToken": "accessToken", "filter": {

"all" : false, "labelIDs": [

"labelNames": [

"*设备标签*"

]

} }

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该 API作用于全部对象时，需要显式设置为true
- labelIDs	否	number[]	设备标签ID ；设备标签的唯一标志
- labelNames	否	string[]	设备标签的名称

返回示例：

{

"code": 0, "data": [

{

"labelID": 1,

"labelName": "设备标签", "description": "设备标签"

} ]

}

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object[]	返回结果
- labelID	number	设备标签ID ；设备标签的唯一标志
- labelName	string	设备标签的名称
- description	string	设备标签的描述

错误原因：暂无

4.4.2.1.2. 新增设备标签

· 请求地址： https://$host/iotp/api/open/deviceManagement/device/label/create

功能说明：该API用于新增设备标签请求示例：

{

"accessToken": "accessToken", "labelName": "设备标签",

"description": "设备标签" }

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
labelName	是	string	硬件类型的标签名称
description	否	string	设备标签的描述

返回示例：

{

"code": 0, "data": {

"labelID": 1,

"labelName": "设备标签", "description": "设备标签"

} }

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- labelID	number	设备标签ID ；设备标签的唯一标志
- labelName	string	设备标签的名称
- description	string	设备标签的描述

错误原因：暂无

4.4.2.1.3. 编辑设备标签

. 请求地址： https://$host/iotp/api/open/deviceManagement/device/label/update

功能说明：该API用于修改设备标签的名称和描述请求示例：

{

"accessToken": "accessToken", "filter": {

"labelID": 1, },

"labelName": "设备标签", "description": "设备标签"

}

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- labelID	是	number	设备标签ID ；设备标签的唯一标志
labelName	否	string	设备标签的名称
description	否	string	设备标签的描述

返回示例：

{

"code": 0, "data": {

"labelID": 1,

"labelName": "设备标签", "description": "设备标签"

} }

{

"code": 2001,

"errmsg": "存在同名的设备标签", "data": {

"labelID": 1,

"labelName": "设备标签", "description": "设备标签"

} }

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
errmsg	string	错误描述；开发者需根据code是否为0判断是否调用成功；而 errmsg仅作参考，后续可能会有变动，因此不可作为是否调用成功的判据
data	object	返回结果
- labelID	number	设备标签ID ；设备标签的唯一标志
- labelName	string	设备标签的名称
- description	string	设备标签的描述

错误原因：暂无

4.4.2.1.4. 删除设备标签

· 请求地址： https://$host/iotp/api/open/deviceManagement/device/label/delete

功能说明：该API用于删除设备标签，支持批量操作请求示例：

{

"accessToken": "accessToken",

"filter": {

"all": true, "labelIDs": [

"labelNames": [

"*设备标签*"

]

} }

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该 API作用于全部对象时，需要显式设置为true
- labelIDs	否	number[]	设备标签ID ；设备标签的唯一标志
- labelNames	否	string[]	设备标签的名称

返回示例：

{

"code": 0, "data": [

{

"success": true, "labelID": 1,

"labelName": "设备标签",

"description": "设备标签", "result": "删除成功"

} ]

}

{

"code": 0,

"errmsg": "删除设备标签失败", "data": [

{

"success": false, "labelID": 1,

"labelName": "设备标签",

"description": "设备标签",

"result": "设备标签正在被使用" }

] }

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
errmsg	string	错误描述；开发者需根据code是否为0判断是否调用成功；而 errmsg仅作参考，后续可能会有变动，因此不可作为是否调用成功的判据
data	object[]	返回结果
- success	boolen	结果标志；为true时表示请求成功，为false时表示请求失败
- labelID	number	设备标签ID ；设备标签的唯一标志
- labelName	string	设备标签的名称
- description	string	设备标签的描述
- result	string	结果的详细说明

错误原因：暂无

4.4.2.2.类型

4.4.2.2.1. 获取设备类型列表

. 请求地址： https://$host/iotp/api/open/deviceManagement/device/type/list

功能说明：该API用于获取设备类型列表请求示例：

{

"accessToken": "accessToken", "fields": [

"info", "states"

"filter": {

"all": true,

"deviceTypeIDs": [

"0fd0324430000002af1314589f9a7534c"

"deviceTypeNames": [

"*插座*"

"deviceClassification": [

"插座"

] }

}

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
fields	否	string[]	结果域；指定返回结果中包含的内容；取值范围为"info"和"states" ；其中"info"表示基本信息，"states"表示状态列表
- filter	否	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- - all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为true
- - deviceTypeIDs	否	string[]	设备类型ID ；设备类型的唯一标志
- - deviceTypeNames	否	string[]	设备类型名称
- - deviceClassification	否	string	设备类型分类；唯一标志；用户可通过该字段，确定设备类型的功能和使用场景；只有内置设备类型才有该字段

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object[]	返回结果
- deviceTypeID	string	设备类型ID ；设备类型的唯一标志
- info	object	设备类型的基础信息
- - deviceClassification	string	设备类型分类；唯一标志；用户可通过该字段，确定设备类型的功能和使用场景；只有内置设备类型才有该字段
- - deviceTypeName	string	设备类型名称
- - icon	string	图标
- - description	string	设备类型描述
- states	object[]	状态列表
- - stateID	string	状态ID ；状态的唯一标志
- - stateName	string	状态名称
- - unit	string	单位
- - valueType	string	取值类型；有"int","float","enum","string"四种；其中"int"表示整型， "float"表示浮点型， "enum"表示枚举型， "string"表示字符串类型
- - valueRange	object	取值范围
- - - min	number	最小值；当valueType的值为"int"或"float"时有效
- - - max	number	最大值；当valueType的值为"int"或"float"时有效
- - - decimal	number	小数位；当valueType的值为"float"时有效
- - - regexp	string	正则表达式；当valueType的值为"string"时有效
- - controllable	boolen	控制标志；为true时表示该状态可以控制，为false时表示该状态不可控制；
- configs	object[]	配置列表
- - configID	string	配置ID ；配置的唯一标志
- - configName	string	配置名称
- - unit	string	单位
- - valueType	string	取值类型；有"int","float","enum","string"四种；其中"int"表示整型， "float"表示浮点型， "enum"表示枚举型， "string"表示字符串类型
- - valueRange	object	取值范围

字段名	类型	说明
- - - min	number	最小值；当valueType的值为"int"或"float"时有效
- - - max	number	最大值；当valueType的值为"int"或"float"时有效
- - - decimal	number	小数位；当valueType的值为"float"时有效
- - - regexp	string	正则表达式；当valueType的值为"string"时有效
- - controllable	boolen	控制标志；为true时表示该配置可以控制，为false时表示该配置不可控制；

错误原因：暂无

4.4.2.3. 获取设备列表

. 请求地址： https://$host/iotp/api/open/deviceManagement/device/list

功能说明：该API用于获取设备列表请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
fields	否	string[]	结果域；指定返回结果中包含的内容；取值范围为"info"和"states" ；其中"info"表示基本信息，"states"表示状态列表
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或” 的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为true
- deviceTypeIDs	否	string[]	设备类型ID ；设备类型的唯一标志
- deviceTypeNames	否	string[]	设备类型名称
- deviceIDs	否	string[]	设备ID ；设备的唯一标志
- deviceNames	否	string[]	设备名称
- deviceStatus	否	string[]	设备状态；有"normal"和"abnormal"两种；其中"normal"表示正常状态， "abnormal"表示异常状态
- spaceIDs	否	number[]	空间ID ；空间的唯一标志
- spaceNames	否	string[]	空间名称
- spaceRecursive	否	boolen	空间递归查找标志；为true时将作用于指定空间及其子空间；不指定或为false时，将只作用于指定空间
- labelIDs	否	number[]	设备标签ID ；设备标签的唯一标志
- labelNames	否	string[]	设备标签的名称
order	否	object	排序参数；为空则按设备名称顺序排序
- field	否	string[]	排序作用域；有"info"和"state"两种；其中"info"表示按基本信息排序， "state"表示按状态值排序
- key	否	string[]	排序键；当field字段的值为"info"时，取值为 info字段的各个子项的字段名；当field字段的值为"state"时，取值为stateID
- orderBy	否	string	排序顺序；有"asc"和"desc"两种；其中"asc"表示顺序排序， "desc"表示逆序排序
paging	否	object	分页参数；为空表示返回所有结果

字段名	必须	类型	说明
- offset	否	number	偏移位置；从结果列表的该偏移位置开始返回，为0表示从第一个结果开始返回
- size	否	number	期望的结果数量；返回结果中将包含不超过指定数量的数据

返回示例：

{

"code": 0, "data": {

"paging": {

"nextOffset": 0

"results": [ {

"deviceTypeID": "0b1dbfb8a1c9a9891206e371fc269e166", "deviceID": "VT1574857882979158901",

"info": {

"spaceID": 1001,

"spaceName": "全公司",

"deviceTypeName": "插座",

"deviceName": "插座",

"deviceStatus": "abnormal", "statusDescription": "离线", "onlineDuration": 2514370,

"onlineTime": "2019-10-28 18:03:34", "reportDuration": 2514370,

"reportTime": "2019-10-28 18:03:34", "labelID": 1,

"labelName": "IOT", },

"states": [ {

"stateID": "DEV_STATE",

"reported": 1, "desired": 0,

"expireIn": 300

} ]

} }

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- paging	object	分页番薯
- - nextOffset	number	下一页的偏移量；为0表示没有剩余数据
- results	object[]	设备列表
- - deviceTypeID	string	设备类型ID ；设备类型的唯一标志
- - deviceID	string	设备ID ；设备的唯一标志
- - info	object	设备的基础信息
- - - spaceID	number	空间ID ；空间的唯一标志
- - - spaceName	string	空间名称
- - - deviceTypeName	string	设备类型名称
- - - deviceName	string	设备名称
- - - deviceStatus	string	设备状态；有"normal"和"abnormal"两种；其中"normal"表示正常状态， "abnormal"表示异常状态
- - - statusDescription	string	设备状态描述；有"正常"和"异常"两种
- - - onlineDuration	number	上线时间距离当前时间的时间间隔；单位为秒
- - - onlineTime	string	上线时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- - - reportDuration	number	最近上报时间距离当前时间的时间间隔；单位为秒
- - - reportTime	string	最近上报时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- - - labelID	number	设备标签ID ；设备标签的唯一标志
- - - labelName	string	设备标签的名称
- - states	object[]	状态列表
- - - stateID	string	状态ID ；状态的唯一标志
- - - reported	all	设备上报的状态值
- - - desired	all	设备期望的状态值
- - - expireIn	否	number

错误原因：

错误码	说明
code	number

4.4.2.4. 编辑设备

· 请求地址： https://$host/iotp/api/open/deviceManagement/device/update

功能说明：该API用于重命名和移动设备，支持批量操作请求示例：

{

"accessToken": "accessToken", "filter": {

"all": true,

"deviceTypeIDs": [

"fd0324430000002af1314589f9a7534c"

"deviceIDs": [

"*GAK*",

"GBK0000001"

"deviceNames": [

"*智能插座*"

"deviceStatus": [ "normal",

"abnormal"

"spaceIDs": [

"spaceNames": [

"*A栋*"

"spaceRecursive": true, "labelIDs": [

"labelNames": [

"*设备标签*"

] },

"info": {

"spaceID": 1001,

"deviceName": "GIK8190083", "labelID": 1,

} }

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为 “与”的关系，同类型的筛选条件之间为“或”的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为 true
- deviceTypeIDs	否	string[]	设备类型ID ；设备类型的唯一标志
- deviceIDs	否	string[]	设备ID ；设备的唯一标志
- deviceNames	否	string[]	设备名称
- deviceStatus	否	string[]	设备状态；有"normal"和"abnormal"两种；其中"normal"表示正常状态， "abnormal"表示异常状态
- spaceIDs	否	number[]	空间ID ；空间的唯一标志
- spaceNames	否	string[]	空间名称
- spaceRecursive	否	boolen	空间递归查找标志；为true时将作用于指定空间及其子空间；不指定或为false时，将只作用于指定空间
- labelIDs	否	number[]	设备标签ID ；设备标签的唯一标志
- labelNames	否	string[]	设备标签的名称
info	是	object	设备的基础信息
spaceID	否	string	空间ID ；空间的唯一标志
deviceName	否	string	设备名称
labelID	否	number	设备标签ID ；设备标签的唯一标志

返回示例：

{

"code": 0, "data": [

{

"success": true,

"deviceTypeID": "0fd0324430000002af1314589f9a7534c",

"deviceTypeName": "智能插座", "deviceID": "GEK0000001",

"deviceName": "GEK0000001", "result": "编辑成功"

} ]

}

{

"code": 2001,

"errmsg": "编辑硬件失败", "data": [

{

"success": false,

"deviceTypeID": "0fd0324430000002af1314589f9a7534c",

"deviceTypeName": "智能插座", "deviceID": "GEK0000001",

"deviceName": "GEK0000001",

"result": "空间下存在相同的硬件名称" }

] }

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
errmsg	string	错误描述；开发者需根据code是否为0判断是否调用成功；而errmsg仅作参考，后续可能会有变动，因此不可作为是否调用成功的判据
data	object[]	返回结果
- success	boolen	结果标志；为true时表示请求成功，为false时表示请求失败
- deviceTypeID	string	设备类型ID ；设备类型的唯一标志
- deviceTypeName	string	设备类型名称
- deviceID	string	设备ID ；设备的唯一标志
- deviceName	string	设备名称
- result	string	结果的详细说明

错误原因：

错误码	说明
code	number

4.4.2.5. 控制设备

· 请求地址： https://$host/iotp/api/open/deviceManagement/device/control

功能说明：该API用于控制设备，支持批量操作请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为true
- deviceTypeID	否	string	设备类型ID ；设备类型的唯一标志
- deviceTypeName	否	string	设备类型名称
- deviceIDs	否	string[]	设备ID ；设备的唯一标志
- deviceNames	否	string[]	设备名称
- deviceStatus	否	string[]	设备状态；有"normal"和"abnormal"两种；其中"normal"表示正常状态， "abnormal"表示异常状态
- spaceIDs	否	number[]	空间ID ；空间的唯一标志
- spaceNames	否	string[]	空间名称
- spaceRecursive	否	boolen	空间递归查找标志；为true时将作用于指定空间及其子空间；不指定或为false时，将只作用于指定空间
- labelIDs	否	number[]	设备标签ID ；设备标签的唯一标志
- labelNames	否	string[]	设备标签的名称
states	否	object[]	状态列表
- stateID	是	string	状态ID ；状态的唯一标志
- value	是	all	状态值
- expireIn	否	number	过期时间；若设备未能在过期时间之前完成状态同步，则控制命令失效；单位为秒；
configs	否	object[]	配置列表
- configID	是	string	配置ID ；配置的唯一标志
- value	是	all	配置值
controlDESC	否	string	控制理由；当设备类型的指定字段强制要求控制理由时，此字段为必填项

返回示例：

{

"code": 0, "data": [

{

"success": true,

"deviceTypeID": "0fd0324430000002af1314589f9a7534c",

"deviceTypeName": "智能插座", "deviceID": "GEK0000001",

"deviceName": "GEK0000001", "result": "控制设备成功"

} ]

}

{

"code": 2001,

"errmsg": "控制设备失败", "data": [

{

"success": false,

"deviceTypeID": "0fd0324430000002af1314589f9a7534c",

"deviceTypeName": "智能插座", "deviceID": "GEK0000001",

"deviceName": "GEK0000001", "result": "设备不存在"

}, {

"success": true,

"deviceTypeID": "0fd0324430000002af1314589f9a7534c",

"deviceTypeName": "智能插座", "deviceID": "GEK0000002",

"deviceName": "GEK0000002", "result": "控制设备成功"

}

] }

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
errmsg	string	错误描述；开发者需根据code是否为0判断是否调用成功；而errmsg仅作参考，后续可能会有变动，因此不可作为是否调用成功的判据
data	object[]	返回结果
- success	boolen	结果标志；为true时表示请求成功，为false时表示请求失败
- deviceTypeID	string	设备类型ID ；设备类型的唯一标志
- deviceTypeName	string	设备类型名称
- deviceID	string	设备ID ；设备的唯一标志
- deviceName	string	设备名称
- result	string	结果的详细说明

错误原因：

错误码	说明
code	number

4.4.2.6. 撤销控制设备

· 请求地址： https://$host/iotp/api/open/deviceManagement/device/cancel

功能说明：该API用于撤销设备的控制命令，支持批量操作请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为true
- deviceTypeID	否	string	设备类型ID ；设备类型的唯一标志
- deviceTypeName	否	string	设备类型名称
- deviceIDs	否	string[]	设备ID ；设备的唯一标志
- deviceNames	否	string[]	设备名称
- deviceStatus	否	string[]	设备状态；有"normal"和"abnormal"两种；其中"normal"表示正常状态， "abnormal"表示异常状态
- spaceIDs	否	number[]	空间ID ；空间的唯一标志
- spaceNames	否	string[]	空间名称
- spaceRecursive	否	boolen	空间递归查找标志；为true时将作用于指定空间及其子空间；不指定或为false时，将只作用于指定空间
- labelIDs	否	number[]	设备标签ID ；设备标签的唯一标志
- labelNames	否	string[]	设备标签的名称
states	否	object[]	状态列表
- stateID	是	string	状态ID ；状态的唯一标志

返回示例：

{

"code": 0, "data": [

{

"success": true,

"deviceTypeID": "0fd0324430000002af1314589f9a7534c",

"deviceTypeName": "智能插座", "deviceID": "GEK0000001",

"deviceName": "GEK0000001", "result": "取消控制成功"

} ]

}

{

"code": 2001,

"errmsg": "取消控制失败", "data": [

{

"success": false,

"deviceTypeID": "0fd0324430000002af1314589f9a7534c",

"deviceTypeName": "智能插座", "deviceID": "GEK0000001",

"deviceName": "GEK0000001", "result": "硬件不存在"

}, {

"success": true,

"deviceTypeID": "0fd0324430000002af1314589f9a7534c",

"deviceTypeName": "智能插座", "deviceID": "GEK0000002",

"deviceName": "GEK0000002", "result": "取消控制成功"

}

] }

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
errmsg	string	错误描述；开发者需根据code是否为0判断是否调用成功；而errmsg仅作参考，后续可能会有变动，因此不可作为是否调用成功的判据
data	object[]	返回结果
- success	boolen	结果标志；为true时表示请求成功，为false时表示请求失败
- deviceTypeID	string	设备类型ID ；设备类型的唯一标志
- deviceTypeName	string	设备类型名称
- deviceID	string	设备ID ；设备的唯一标志
- deviceName	string	设备名称
- result	string	结果的详细说明

错误原因：

错误码	说明
code	number

4.5.事件管理

4.5.1. 告警

4.5.1.1. 获取告警列表

. 请求地址： https://$host/iotp/api/open/eventManagement/alarm/list

功能说明：该API用于获取告警列表请求示例：

{

"accessToken": "accessToken",

"fields": [

"info",

"policy",

"space",

"device",

"notification", "confirmation", "deal",

"vedios"

"filter": {

"all": true,

"timeStart": "2019-10-28 00:00:00" "timeEnd": "2019-10-29 00:00:00",

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
fields	否	string[]	结果域；指定返回结果中包含的内容；取值范围为"info"、"policy"、"space"、"device"、"notification"、"confirmation"、"deal"] ；其中"info"表示告警基本信息，"policy"表示触发策略信息，"space"表示触发空间信息，"device"表示触发设备信息，"notification"表示告警通知信息，"confirmation"表示告警确认信息，"deal"表示告警处理信息,"vedios"表示视频信息
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为true
- timeStart	否	string	开始时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- timeEnd	否	string	结束时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- dateObjectIDs	否	number[]	日期对象ID ；日期对象的唯一标志
- timeObjectIDs	否	number[]	时间对象ID ；时间对象的唯一标志
- alarmLevels	否	string[]	告警等级；有"general"、"minor"、"major"、"critical"四种；其中"general"表示一般告警，"minor"表示次要告警、"major"表示重要告警、"critical"表示严重告警
- alarmStatus	否	string[]	告警状态；有"notify"、"confirmed"和"dealt"三种；其中"notify"表示告警已通知，"confirmed"表示告警已确认，"dealt"表示告警已处理
- policyIDs	否	number[]	策略ID ；策略的唯一标志
- policyNames	否	string[]	策略名称
- spaceIDs	否	number[]	空间ID ；空间的唯一标志
- spaceNames	否	string[]	空间名称
- spaceRecursive	否	boolen	空间递归查找标志；为true时将作用于指定空间及其子空间；不指定或为false时，将只作用于指定空间
- deviceTypeIDs	否	string[]	设备类型ID ；设备类型的唯一标志
- deviceTypeNames	否	string[]	设备类型名称
positioning	是	object	定位参数
- maxID	否	number	最大ID ；返回结果中的ID值均小于maxID ；为空表示不做限制
- sinceID	否	number	最小ID ；返回结果中的ID值均大于sinceID ；为空表示不做限制
- count	是	number	期望的结果数量；返回结果中将包含不超过指定数量的数据

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- positioning	object	定位参数
- - left	number	剩余结果数量；在maxI D和sinceID的限定范围内，剩余的结果数量
- results	object[]	告警记录列表
- - alarmID	number	告警记录ID ；告警记录的唯一标志
- - info	object	告警基础信息
- - - alarmTime	string	告警时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- - - alarmLevel	string	告警等级；有"general"、"minor"、"major"、"critical"四种；其中"general"表示一般告警，"minor"表示次要告警、"major"表示重要告警、"critical"表示严重告警
- - - alarmStatus	string	告警状态；有"notify"、"confirmed"和"dealt"三种；其中"notify"表示告警已通知，"confirmed"表示告警已确认，"dealt"表示告警已处理
- - - content	string	告警内容
- - - snapshots	string[]	抓拍照片列表
- - policy	object	触发策略信息
- - - policy ID	number	策略ID ；策略的唯一标志
- - - policyName	string	策略名称
- - space	object	触发空间信息
- - - spaceID	number	空间ID ；空间的唯一标志
- - - spaceName	string	空间名称
- - - spacePath	string	空间路径；由空间ID(spaceID)和斜杠(/)分隔符组成；最后一个ID为当前空间ID
- - device	object	触发设备信息
- - - deviceTypeID	string	设备类型ID ；设备类型的唯一标志
- - - deviceTypeName	string	设备类型名称
- - - device ID	string	设备ID ；设备的唯一标志
- - - deviceName	string	设备名称
- - notification	object	告警通知信息
- - - count	number	告警通知次数

字段名	类型	说明
- - - methods	string[]	告警通知方式；有"sms"、"app"、"call"、"dingding"和"wechat"共五种；其中"sms"表示通过短信通知，"app"表示通过APP通知，"call"表示通过电话通知，"dingding"表示通过阿里钉钉通知，"wechat"表示通过企业微信通知
- - - notifiers	object[]	告警通知人列表
- - - - accountID	number	账户ID ，账户的唯一标志
- - - - accountName	string	账户名称
- - confirmation	object	告警确认信息
- - - accountID	number	账户ID ，账户的唯一标志
- - - accountName	string	账户名称
- - - confirmTime	string	确认告警时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- - deal	object	告警处理信息
- - - accountID	string	账户ID ，账户的唯一标志
- - - accountName	string	账户名称
- - - dealTime	string	处理告警时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- - vedios	[]object	视频信息
- - - info	object	基本信息
- - - - timeStart	否	string
- - - - timeEnd	否	string
- - - info	object	网络摄像机信息信息
- - - - deviceTypeID	string	设备类型ID ；设备类型的唯一标志
- - - - deviceTypeName	string	设备类型名称
- - - - device ID	string	设备ID ；设备的唯一标志
- - - - deviceName	string	设备名称
- - - - nvrIP	string	关联NVR设备的IP地址
- - - - nvrPort	number	关联NVR设备的端口号
- - - - nvrChannel	number	关联NVR设备的通道号

错误原因：

错误码	说明
code	number

4.5.1.2. 确认告警

· 请求地址： https://$host/iotp/api/open/eventManagement/alarm/confirm

功能说明：该API用于确认告警，支持批量操作请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- all	否	boo len	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该 API作用于全部对象时，需要显式设置为true
- timeStart	否	string	开始时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- timeEnd	否	string	结束时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- dateObjectIDs	否	number[]	日期对象ID ；日期对象的唯一标志
- timeObjectIDs	否	number[]	时间对象ID ；时间对象的唯一标志
- alarmLevels	否	string[]	告警等级；有"general"、"minor"、"major"、"critical"四种；其中"general"表示一般告警，"minor"表示次要告警、"major"表示重要告警、"critical"表示严重告警
- alarmStatus	否	string[]	告警状态；有"notify"、"confirmed"和"dealt"三种；其中"notify"表示告警已通知，"confirmed"表示告警已确认，"dealt"表示告警已处理
- policy IDs	否	number[]	策略ID ；策略的唯一标志
- policyNames	否	string[]	策略名称
- spaceIDs	否	number[]	空间ID ；空间的唯一标志
- spaceNames	否	string[]	空间名称
- spaceRecursive	否	boo len	空间递归查找标志；为true时将作用于指定空间及其子空间；不指定或为false时，将只作用于指定空间
- deviceTypeIDs	否	string[]	设备类型ID ；设备类型的唯一标志
- deviceTypeNames	否	string[]	设备类型名称

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object[]	返回结果
- success	boolen	结果标志；为true时表示请求成功，为false时表示请求失败
- alarmID	number	告警记录ID ；告警记录的唯一标志
- result	string	结果的详细说明

错误原因：

错误码	说明
code	number

4.5.1.3. 消除告警

请求地址： https://$host/iotp/api/open/eventManagement/alarm/deal

功能说明：该API用于消除告警，支持批量操作请求示例：

{

"accessToken": "accessToken", "filter": {

"all": true,

"timeStart": "2019-10-28 00:00:00" "timeEnd": "2019-10-29 00:00:00", "dateObjectIDs": [

"timeObjectIDs": [ 4,

"alarmLevels": [ "general",

"minor", "major",

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- all	否	boo len	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该 API作用于全部对象时，需要显式设置为true
- timeStart	否	string	开始时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- timeEnd	否	string	结束时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- dateObjectIDs	否	number[]	日期对象ID ；日期对象的唯一标志
- timeObjectIDs	否	number[]	时间对象ID ；时间对象的唯一标志
- alarmLevels	否	string[]	告警等级；有"general"、"minor"、"major"、"critical"四种；其中"general"表示一般告警，"minor"表示次要告警、"major"表示重要告警、"critical"表示严重告警
- alarmStatus	否	string[]	告警状态；有"notify"、"confirmed"和"dealt"三种；其中"notify"表示告警已通知，"confirmed"表示告警已确认，"dealt"表示告警已处理
- policy IDs	否	number[]	策略ID ；策略的唯一标志
- policyNames	否	string[]	策略名称
- spaceIDs	否	number[]	空间ID ；空间的唯一标志
- spaceNames	否	string[]	空间名称
- spaceRecursive	否	boo len	空间递归查找标志；为true时将作用于指定空间及其子空间；不指定或为false时，将只作用于指定空间
- deviceTypeIDs	否	string[]	设备类型ID ；设备类型的唯一标志
- deviceTypeNames	否	string[]	设备类型名称

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object[]	返回结果
- success	boolen	结果标志；为true时表示请求成功，为false时表示请求失败
- alarmID	number	告警记录ID ；告警记录的唯一标志
- result	string	结果的详细说明

错误原因：

错误码	说明
code	number

4.5.2. 巡检

4.5.2.1. 获取巡检列表

请求地址： https://$host/iotp/api/open/eventManagement/inspection/list

功能说明：该API用于获取巡检列表请求示例：

{

"accessToken": "accessToken", "withAbnormalList": true,

"filter": {

"all": true,

"timeStart": "2019-10-28 00:00:00" "timeEnd": "2019-10-29 00:00:00", "dateObjectIDs": [

"timeObjectIDs": [ 4,

"inspectionIDs": [ 6,

"inspectionNames": [

"*智能策略*"

] },

"positioning": { "maxID": 3,

"sinceID": 1, "count": 2

} }

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
withAbnormalList	否	boolen	异常设备列表标志；为true时，返回结果将包含异常设备列表；为空或为false时，返回结果将不包含异常设备列表
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或” 的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为true
- timeStart	否	string	开始时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- timeEnd	否	string	结束时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- dateObjectIDs	否	number[]	日期对象ID ；日期对象的唯一标志
- timeObjectIDs	否	number[]	时间对象ID ；时间对象的唯一标志
- inspectionIDs	否	number[]	巡检策略ID ；巡检策略的唯一标志
- inspectionNames	否	string[]	巡检策略名称
positioning	是	object	定位参数
- maxID	否	number	最大ID ；返回结果中的ID值均小于maxID ；为空表示不做限制
- sinceID	否	number	最小ID ；返回结果中的ID值均大于sinceID ；为空表示不做限制
- count	是	number	期望的结果数量；返回结果中将包含不超过指定数量的数据

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- positioning	object	定位参数
- - left	number	剩余结果数量；在maxID和sinceID的限定范围内，剩余的结果数量
- results	object[]	巡检策略列表
- - inspectionID	number	巡检策略ID ；巡检策略的唯一标志
- - inspectionName	string	巡检策略名称
- - inspectionTime	string	巡检时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- - deviceInfos	object[]	设备信息列表
- - - deviceTypeID	string	设备类型ID ；设备类型的唯一标志
- - - deviceTypeName	string	设备类型名称
- - - normalCount	number	正常设备数量
- - - abnormalCount	number	异常设备数量
- - - abnormalList	object[]	异常设备列表
- - - - deviceID	string	设备ID ；设备的唯一标志
- - - - deviceName	string	设备名称
- - - - result	string	设备异常原因

错误原因：

错误码	说明
code	number

4.5.3. 云守护

4.5.3.1.获取云守护告警列表

请求地址： https://$host/iotp/api/open/eventManagement/cloudGuardian/list

功能说明：该API用于获取云守护告警列表请求示例：

"withAbnormalList": true, "filter": {

"all": true,

"timeStart": "2019-10-28 00:00:00" "timeEnd": "2019-10-29 00:00:00"

"positioning": { "maxID": 3,

"sinceID": 1, "count": 2

} }

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
withAbnormalList	否	boolen	异常设备列表标志；为true时，返回结果将包含异常设备列表；为空或为false时，返回结果将不包含异常设备列表
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为 “与”的关系，同类型的筛选条件之间为“或”的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为true
- timeStart	否	string	开始时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- timeEnd	否	string	结束时间；时间格式为"yyyy-MM-dd HH:mm:ss"
positioning	是	object	定位参数
- maxID	否	number	最大ID ；返回结果中的ID值均小于maxID ；为空表示不做限制
- sinceID	否	number	最小ID ；返回结果中的ID值均大于sinceID ；为空表示不做限制
- count	是	number	期望的结果数量；返回结果中将包含不超过指定数量的数据

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- positioning	object	定位参数
- - left	number	剩余结果数量；在maxID和sinceID的限定范围内，剩余的结果数量
- results	object[]	云守护告警列表
- - cloudGuardianID	number	云守护告警记录ID ；云守护告警记录的唯一标志
- - cloudGuardianStates	object[]	云守护告警记录的状态列表
- - - time	string	状态变更时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- - - state	string	云守护告警记录的状态；有"reported"和"eliminated"两种；其中"reported"表示告警上报， "eliminated"表示告警消除
- - - content	string	云守护告警记录的状态说明

错误原因：

错误码	说明
code	number

4.5.4. 设备操作

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或” 的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为true
- timeStart	否	string	开始时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- timeEnd	否	string	结束时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- spaceIDs	否	number[]	空间ID ；空间的唯一标志
- spaceNames	否	string[]	空间名称
- spaceRecursive	否	boolen	空间递归查找标志；为true时将作用于指定空间及其子空间；不指定或为false时，将只作用于指定空间
- deviceTypeIDs	否	string[]	设备类型ID ；设备类型的唯一标志
- deviceTypeNames	否	string[]	设备类型名称
- deviceIDs	否	string[]	设备ID ；设备的唯一标志
- deviceNames	否	string[]	设备名称
- accountIDs	否	number[]	账户ID ，账户的唯一标志
- accountNames	否	string[]	账户名称
positioning	是	object	定位参数
- maxID	否	number	最大ID ；返回结果中的ID值均小于maxID ；为空表示不做限制
- sinceID	否	number	最小ID ；返回结果中的ID值均大于sinceID ；为空表示不做限制
- count	是	number	期望的结果数量；返回结果中将包含不超过指定数量的数据

返回示例：

"positioning": { "left": 30

"results": [ {

"deviceOperationID": 5,

"time": "2019-11-29 17:24:50" "content": "设备上线"

} ]

} }

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- positioning	object	定位参数
- - left	number	剩余结果数量；在maxID和sinceID的限定范围内，剩余的结果数量
- results	object[]	开锁记录列表
- - deviceOperationID	number	设备操作记录ID ；设备操作记录的唯一标志
- - time	string	设备操作的记录时间
- - content	string	设备操作说明

错误原因：

错误码	说明
code	number

4.5.5. 开锁记录

请求地址： https://$host/iotp/api/open/eventManagement/unlockingRecord/list

功能说明：该API用于获取开锁记录请求示例：

{

"accessToken": "accessToken", "filter": {

"all": true,

"timeStart": "2019-10-28 00:00:00" "timeEnd": "2019-10-29 00:00:00", "spaceIDs": [

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或” 的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为true
- timeStart	否	string	开始时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- timeEnd	否	string	结束时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- spaceIDs	否	number[]	空间ID ；空间的唯一标志
- spaceNames	否	string[]	空间名称
- spaceRecursive	否	boolen	空间递归查找标志；为true时将作用于指定空间及其子空间；不指定或为false时，将只作用于指定空间
- deviceTypeIDs	否	string[]	设备类型ID ；设备类型的唯一标志
- deviceTypeNames	否	string[]	设备类型名称
- deviceIDs	否	string[]	设备ID ；设备的唯一标志
- deviceNames	否	string[]	设备名称
- accountIDs	否	number[]	账户ID ，账户的唯一标志
- accountNames	否	string[]	账户名称
positioning	是	object	定位参数
- maxID	否	number	最大ID ；返回结果中的ID值均小于maxID ；为空表示不做限制
- sinceID	否	number	最小ID ；返回结果中的ID值均大于sinceID ；为空表示不做限制
- count	是	number	期望的结果数量；返回结果中将包含不超过指定数量的数据

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- positioning	object	定位参数
- - left	number	剩余结果数量；在maxI D和sinceID的限定范围内，剩余的结果数量
- results	object[]	开锁记录列表
- - unlockingRecordID	number	开锁记录ID ；开锁记录的唯一标志
- - unlockingMethod	string	开锁方式；有"password"、"fingerprint"和"accessCard"三种；其中"password"表示密码开锁，"fingerprint"表示指纹开锁，"accessCard"表示门禁卡开锁
- - account	object	账户信息
- - - accountID	number	账户ID ，账户的唯一标志
- - - accountName	string	账户名称
- - space	object	空间信息
- - - spaceID	number	空间ID ；空间的唯一标志
- - - spaceName	string	空间名称
- - device	object	设备信息
- - - deviceTypeID	string	设备类型ID ；设备类型的唯一标志
- - - deviceTypeName	string	设备类型名称
- - - device ID	string	设备ID ；设备的唯一标志
- - - deviceName	string	设备名称

错误原因：

错误码	说明
code	number

4.5.6. 视频记录

请求地址： https://$host/iotp/api/open/eventManagement/vedioRecord/list

功能说明：该API用于获取视频记录请求示例：

"all": true,

"timeStart": "2019-10-28 00:00:00" "timeEnd": "2019-10-29 00:00:00", "spaceIDs": [

"spaceNames": [

"*A栋*"

"spaceRecursive": true, "deviceTypeIDs": [

"0fd0324430000002af1314589f9a7

"deviceTypeNames": [

"*智能门锁*"

"deviceIDs": [

"*GAK*",

"GBK0000001"

"deviceNames": [

"*智能门锁*"

"alarmTypes": [

"rangeAlarm", "alarmPolicy", "linkage"

"alarmLevels": [ "general",

"minor",

"major",

"critical"

"alarmPolicyNames": [

"*漏水告警*"

"contents": [

"*发生了漏水，空开断电*"

] },

"positioning": { "maxID": 3,

"sinceID": 1, "count": 2

} }

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该 API作用于全部对象时，需要显式设置为true
- timeStart	否	string	开始时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- timeEnd	否	string	结束时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- spaceIDs	否	number[]	空间ID ；空间的唯一标志
- spaceNames	否	string[]	空间名称
- spaceRecursive	否	boolen	空间递归查找标志；为true时将作用于指定空间及其子空间；不指定或为false时，将只作用于指定空间
- deviceTypeIDs	否	string[]	设备类型ID ；设备类型的唯一标志
- deviceTypeNames	否	string[]	设备类型名称
- deviceIDs	否	string[]	设备ID ；设备的唯一标志
- deviceNames	否	string[]	设备名称
- alarmTypes	否	boolen	告警类型；有"rangeAlarm", "alarmPolicy", "linkage"三种；其中"rangeAlarm"表示值域告警，"alarmPolicy"表示自定义告警, ，"linkage"表示联动策略告警
- alarmLevels	否	string[]	告警等级；有"general"、"minor"、"major"、"critical"四种；其中"general"表示一般告警， "minor"表示次要告警、"major"表示重要告警、 "critical"表示严重告警
- alarmPolicyNames	否	string[]	告警策略名称
- contents	[]string	告警内容
positioning	是	object	定位参数
- maxID	否	number	最大ID ；返回结果中的ID值均小于maxID ；为空表示不做限制
- sinceID	否	number	最小ID ；返回结果中的ID值均大于sinceID ；为空表示不做限制
- count	是	number	期望的结果数量；返回结果中将包含不超过指定数量的数据

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- positioning	object	定位参数
- - left	number	剩余结果数量；在maxID和sinceID的限定范围内，剩余的结果数量
- results	object[]	开锁记录列表
- - vedioRecordID	number	视频记录ID ；视频记录的唯一标志
- - info	object	视频记录ID ；视频记录的唯一标志
- - - timeStart	否	string
- - - timeEnd	否	string
- - - alarmType	number	视频记录ID ；视频记录的唯一标志
- - - alarmLevel	string	告警等级；有"general"、"minor"、"major"、"critical"四种；其中"general"表示一般告警， "minor"表示次要告警、"major"表示重要告警、 "critical"表示严重告警
- - - alarmPolicyName	string	告警策略名称
- - - content	string	告警内容
- - space	object	空间信息
- - - spaceID	number	空间ID ；空间的唯一标志
- - - spaceName	string	空间名称
- - triggerDevice	object	触发设备信息
- - - deviceTypeID	string	设备类型ID ；设备类型的唯一标志
- - - deviceTypeName	string	设备类型名称
- - - deviceID	string	设备ID ；设备的唯一标志
- - - deviceName	string	设备名称
- - ipc	object	网络摄像机信息
- - - deviceTypeID	string	设备类型ID ；设备类型的唯一标志
- - - deviceTypeName	string	设备类型名称
- - - deviceID	string	设备ID ；设备的唯一标志
- - - deviceName	string	设备名称

字段名	类型	说明
- - - nvrIP	string	关联NVR设备的IP地址
- - - nvrPort	number	关联NVR设备的端口号
- - - nvrChannel	number	关联NVR设备的通道号

错误原因：

错误码	说明
code	number

4.6. 数据分析

4.6.1. 原始数据

4.6.1.1. 硬件数据

4.6.1.1.1. 获取硬件数据列表

. 请求地址： https://$host/iotp/api/open/dataAnalysis/rawData/hardware/list

功能说明：该API用于获取硬件数据列表请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- hardwareTypeID	是	string	硬件类型ID ；硬件类型的唯一标志
- hardwareIDs	否	string[]	硬件ID ；硬件的唯一标志
- hardwareNames	否	string[]	硬件名称
- spaceIDs	否	number[]	空间ID ；空间的唯一标志
- spaceNames	否	string[]	空间名称
- spaceRecursive	否	boolen	空间递归查找标志；为true时将作用于指定空间及其子空间；不指定或为false时，将只作用于指定空间
- timeStart	否	string	开始时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- timeEnd	否	string	结束时间；时间格式为"yyyy-MM-dd HH:mm:ss"
positioning	是	object	定位参数
- maxID	否	number	最大ID ；返回结果中的ID值均小于maxID ；为空表示不做限制
- sinceID	否	number	最小ID ；返回结果中的ID值均大于sinceID ；为空表示不做限制
- count	是	number	期望的结果数量；返回结果中将包含不超过指定数量的数据

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- positioning	object	定位参数
- - left	number	剩余结果数量；在maxID和sinceID的限定范围内，剩余的结果数量
- results	object[]	硬件数据列表
- - dataID	number	硬件数据ID ；硬件数据的唯一标志
- - hardwareTypeID	string	硬件类型ID ；硬件类型的唯一标志
- - hardwareID	string	硬件ID ；硬件的唯一标志
- - time	string	硬件数据的产生时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- - states	object[]	状态列表
- - - stateID	string	状态ID ；状态的唯一标志
- - - value	all	状态值

错误原因：

错误码	说明
code	number

4.6.1.2. 设备数据

4.6.1.2.1. 获取设备数据列表

请求地址： https://$host/iotp/api/open/dataAnalysis/rawData/device/list

功能说明：该API用于获取设备加工数据列表请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为 “与”的关系，同类型的筛选条件之间为“或”的关系
- deviceTypeID	是	string	设备类型ID ；设备类型的唯一标志
- deviceIDs	否	string[]	设备ID ；设备的唯一标志
- deviceNames	否	string[]	设备名称
- spaceIDs	否	number[]	空间ID ；空间的唯一标志
- spaceNames	否	string[]	空间名称
- spaceRecursive	否	boolen	空间递归查找标志；为true时将作用于指定空间及其子空间；不指定或为false时，将只作用于指定空间
- timeStart	否	string	开始时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- timeEnd	否	string	结束时间；时间格式为"yyyy-MM-dd HH:mm:ss"
positioning	是	object	定位参数
- maxID	否	number	最大ID ；返回结果中的ID值均小于maxID ；为空表示不做限制
- sinceID	否	number	最小ID ；返回结果中的ID值均大于sinceID ；为空表示不做限制
- count	是	number	期望的结果数量；返回结果中将包含不超过指定数量的数据

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- positioning	object	定位参数
- - left	number	剩余结果数量；在maxID和sinceID的限定范围内，剩余的结果数量
- results	object[]	设备数据列表
- - dataID	number	设备数据ID ；设备数据的唯一标志
- - deviceTypeID	string	设备类型ID ；设备类型的唯一标志
- - deviceID	string	设备ID ；设备的唯一标志
- - time	string	设备数据的产生时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- - states	object[]	状态列表
- - - stateID	string	状态ID ；状态的唯一标志
- - - value	all	状态值

错误原因：

错误码	说明
code	number

4.6.2. 加工任务

4.6.2.1.获取加工任务列表

请求地址： https://$host/iotp/api/open/dataAnalysis/processingTask/list

功能说明：该API用于获取加工任务列表请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为true
- taskIDs	否	number[]	加工任务ID ；加工任务的唯一标志
- taskNames	否	string[]	加工任务名称
- taskTypes	否	string[]	加工任务类型；有"statistic"、"grading"、"realtime"和"alarm"四种；其中"statistic"表示数值插件，"grading"表示分级插件，"realtime"表示实时插件，"alarm"表示告警插件
paging	否	object	分页参数；为空表示返回所有结果
- offset	否	number	偏移位置；从结果列表的该偏移位置开始返回，为0表示从第一个结果开始返回
- size	否	number	期望的结果数量；返回结果中将包含不超过指定数量的数据

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- paging	object	分页参数
- - nextOffset	number	下一页的偏移量；为0表示没有剩余数据
- results	object[]	加工任务列表
- - taskID	number	加工任务ID ；加工任务的唯一标志
- - taskName	string	加工任务名称
- - taskType	string[]	加工任务类型；有"statistic"、"grading"、"realtime"和"alarm"四种；其中"statistic"表示数值插件，"grading"表示分级插件，"realtime"表示实时插件，"alarm"表示告警插件
- - description	string	加工任务描述
- - state	object	加工任务状态；有"in it"、"ok"、"fail"和"unauthorized"四种；其中"in it"表示加工任务正在初始化，"ok"表示加工任务正常工作，"fail"表示加工任务工作异常，"unauthorized"表示加工任务未授权
- - dataSources	object[]	数据来源列表
- - - dataSourceID	number	数据来源ID ；数据来源的唯一标志
- - - deviceTypeID	string	设备类型ID ；设备类型的唯一标志
- - - deviceTypeName	string	设备类型名称
- - - stateID	string	状态ID ；状态的唯一标志
- - - stateName	string	状态名称
- - dataTypes	object[]	数据类型列表
- - - dataTypeID	string	数据类型ID ；数据类型的唯一标志
- - - dataTypeName	string	数据类型名称
- - - unit	string	单位

错误原因：

错误码	说明
code	number

4.6.3.加工数据

4.6.3.1. 设备数据

4.6.3.1.1. 获取设备加工数据列表

请求地址： https://$host/iotp/api/open/dataAnalysis/processedData/device/list

功能说明：该API用于获取设备加工数据列表请求示例：

{

"accessToken": "accessToken", "dataTypeIDs": [

"max", "min"

"filter": {

"taskID": 2,

"dataSourceID": 1,

"aggregation": "5minute",

"deviceIDs": [ "*VT*",

"VT1574857882979158901"

"deviceNames": [

"*插座*"

"spaceIDs": [

"spaceNames": [

"*A栋*"

"spaceRecursive": true,

"timeStart": "2019-10-28 00:00:00" "timeEnd": "2019-10-29 00:00:00"

"positioning": { "maxID": 3,

"sinceID": 1, "count": 2

} }

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
dataTypeIDs	否	string[]	数据类型ID ；数据类型的唯一标志；指定返回结果中包含的数据类型
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为 “与”的关系，同类型的筛选条件之间为“或”的关系
- taskID	是	number	加工任务ID ；加工任务的唯一标志
- dataSourceID	是	number	数据来源ID ；数据来源的唯一标志
- aggregation	是	number	聚合方式，有"5minute", "hour", "day", "month"四种；其中"5minute"表示对每5分钟的数据进行聚合； "hour", "day", "month"表示对每小时，每天，每月的数据进行聚合
- deviceIDs	否	string[]	设备ID ；设备的唯一标志
- deviceNames	否	string[]	设备名称
- spaceIDs	否	number[]	空间ID ；空间的唯一标志
- spaceNames	否	string[]	空间名称
- spaceRecursive	否	boolen	空间递归查找标志；为true时将作用于指定空间及其子空间；不指定或为false时，将只作用于指定空间
- timeStart	否	string	开始时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- timeEnd	否	string	结束时间；时间格式为"yyyy-MM-dd HH:mm:ss"
positioning	是	object	定位参数
- maxID	否	number	最大ID ；返回结果中的ID值均小于maxID ；为空表示不做限制
- sinceID	否	number	最小ID ；返回结果中的ID值均大于sinceID ；为空表示不做限制
- count	是	number	期望的结果数量；返回结果中将包含不超过指定数量的数据

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- positioning	object	定位参数
- - left	number	剩余结果数量；在maxID和sinceID的限定范围内，剩余的结果数量
- results	object[]	结果列表
- - dataID	number	设备加工数据ID ；数据加工数据的唯一标志
- - deviceTypeID	string	设备类型ID ；设备类型的唯一标志
- - deviceID	string	设备ID ；设备的唯一标志
- - time	string	数据产生时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- - data	object[]	设备加工数据列表
- - - dataTypeID	string	数据类型ID ；数据类型的唯一标志
- - - value	number,string	设备加工数据值

错误原因：

错误码	说明
code	number

4.6.3.2. 空间数据

4.6.3.2.1. 获取空间加工数据列表

· 请求地址： https://$host/iotp/api/open/dataAnalysis/processedData/space/list

功能说明：该API用于获取空间加工数据列表请求示例：

{
"accessToken": "accessToken"	,
"dataTypeIDs": [ "max", "min" ], "filter": { "taskID": 2, "dataSourceID": 1,
"aggregation": "5minute"	,
"spaceIDs": [ 1 ], "spaceNames": [

"*A栋*"

"spaceRecursive": true,

"timeStart": "2019-10-28 00:00:00" "timeEnd": "2019-10-29 00:00:00"

"positioning": { "maxID": 3,

"sinceID": 1, "count": 2

} }

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
dataTypeIDs	否	string[]	数据类型ID ；数据类型的唯一标志；指定返回结果中包含的数据类型
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- taskID	是	number	加工任务ID ；加工任务的唯一标志
- dataSourceID	number	数据来源 ID ；数据来源的唯一标志
- aggregation	是	number	聚合方式，有"5minute", "hour", "day", "month"四种；其中"5minute"表示对每5分钟的数据进行聚合； "hour", "day", "month"表示对每小时，每天，每月的数据进行聚合；
- spaceIDs	否	number[]	空间ID ；空间的唯一标志
- spaceNames	否	string[]	空间名称
- spaceRecursive	否	boolen	空间递归查找标志；为true时将作用于指定空间及其子空间；不指定或为false时，将只作用于指定空间
- timeStart	否	string	开始时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- timeEnd	否	string	结束时间；时间格式为"yyyy-MM-dd HH:mm:ss"
positioning	是	object	定位参数
- maxID	否	number	最大ID ；返回结果中的ID值均小于maxID ；为空表示不做限制
- sinceID	否	number	最小ID ；返回结果中的ID值均大于 sinceID ；为空表示不做限制
- count	是	number	期望的结果数量；返回结果中将包含不超过指定数量的数据

返回示例：

}, "results": [ { "dataID": 2, "spaceID": 5,
"time": "2019-12-19 02:38:37"	,
"fields": [ { "dataTypeID": "max", "value": 223 }, { "dataTypeID": "min", "value": 220 } ] }, { "dataID": 1, "spaceID": 7,
"time": "2019-12-19 02:37:37"	,
"fields": [ { "dataTypeID": "max", "value": 227 }, { "dataTypeID": "min", "value": 225 } ] } ] } }

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- positioning	object	定位参数
- - left	number	剩余结果数量；在maxID和sinceID的限定范围内，剩余的结果数量
- results	object[]	结果列表
- - dataID	number	空间加工数据ID ；数据加工数据的唯一标志
- - spaceID	number	空间ID ；空间的唯一标志
- - time	string	数据产生时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- - data	object[]	空间加工数据列表
- - - dataTypeID	string	数据类型ID ；数据类型的唯一标志
- - - value	all	空间加工数据值

错误原因：

错误码	说明
code	number

4.7.智能策略

4.7.1.边缘策略

4.7.1.1. 网关边缘策略

4.7.1.1.1. 获取网关边缘策略列表

. 请求地址： https://$host/iotp/api/open/policyMangement/edge/gateway/list

功能说明：该API用于获取网关边缘策略列表请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为true
- gatewayPolicyIDs	否	number[]	网关边缘策略ID ；网关边缘策略的唯一标志
- gatewayPolicyNames	否	string[]	网关边缘策略名称
- spaceIDs	否	number[]	空间ID ；空间的唯一标志
- spaceNames	否	string[]	空间名称
- spaceRecursive	否	boolen	空间递归查找标志；为true时将作用于指定空间及其子空间；不指定或为false时，将只作用于指定空间
paging	否	object	分页参数；为空表示返回所有结果
- offset	否	number	偏移位置；从结果列表的该偏移位置开始返回，为0表示从第一个结果开始返回
- size	否	number	期望的结果数量；返回结果中将包含不超过指定数量的数据

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- paging	object	分页参数
- - nextOffset	number	下一页的偏移量；为0表示没有剩余数据
- results	object[]	网关边缘策略列表
- - gatewayPolicyID	number	网关边缘策略ID ；网关边缘策略的唯一标志
- - gatewayPolicyName	string	网关边缘策略名称
- - description	string	网关边缘策略描述
- - enable	boolen	启用标志；为true时表示启用，为false时表示禁用
- - spaceIDs	number[]	空间ID ；空间的唯一标志

错误原因：

错误码	说明
code	number

4.7.1.2.5.7.1.2 终端边缘策略

4.7.1.2.1. 获取终端边缘策略列表

· 请求地址： https://$host/iotp/api/open/policyMangement/edge/terminal/list

功能说明：该API用于获取终端边缘策略列表

请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为true
- terminalPolicyIDs	否	number[]	终端边缘策略ID ；终端边缘策略的唯一标志
- terminalPolicyNames	否	string[]	终端边缘策略名称
- spaceNames	否	string[]	空间名称
- spaceRecursive	否	boolen	空间递归查找标志；为true时将作用于指定空间及其子空间；不指定或为false时，将只作用于指定空间
paging	否	object	分页参数；为空表示返回所有结果
- offset	否	number	偏移位置；从结果列表的该偏移位置开始返回，为0表示从第一个结果开始返回
- size	否	number	期望的结果数量；返回结果中将包含不超过指定数量的数据

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- paging	object	分页参数
- - nextOffset	number	下一页的偏移量；为0表示没有剩余数据
- results	object[]	终端边缘策略列表
- - terminalPolicyID	number	终端边缘策略ID ；终端边缘策略的唯一标志
- - terminalPolicyName	string	终端边缘策略名称
- - description	string	终端边缘策略描述

错误原因：

错误码	说明
code	number

4.7.2.平台策略

4.7.2.1.情景策略

4.7.2.1.1. 获取情景策略列表

请求地址： https://$host/iotp/api/open/policyMangement/platform/scene/list

功能说明：该API用于获取情景策略列表请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为 “或”的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为true
- scenePolicyIDs	否	number[]	情景策略ID ；情景策略的唯一标志
- scenePolicyNames	否	string[]	情景策略名称
- scenePolicyTypes	否	string[]	情景策略类型；有"space"和"device"两种；其中"space"表示空间情景策略， "device"表示设备情景策略
paging	否	object	分页参数；为空表示返回所有结果
- offset	否	number	偏移位置；从结果列表的该偏移位置开始返回，为0表示从第一个结果开始返回
- size	否	number	期望的结果数量；返回结果中将包含不超过指定数量的数据

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- paging	object	分页参数
- - nextOffset	number	下一页的偏移量；为0表示没有剩余数据
- results	object[]	情景策略列表
- - scenePolicyID	number	情景策略ID ；情景策略的唯一标志
- - scenePolicyName	string	情景策略名称
- - scenePolicyType	string	情景策略类型；有"space"和"device"两种；其中"space"表示空间情景策略， "device"表示设备情景策略
- - description	boolen	情景策略描述

错误原因：

错误码	说明
code	number

4.7.2.1.2. 执行情景策略

请求地址： https://$host/iotp/api/open/policyMangement/platform/scene/exec

功能说明：该API用于执行情景策略请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
scenePolicyID	是	number	情景策略ID ；情景策略的唯一标志
spaceID	否	number[]	空间ID ；空间的唯一标志
spaceRecursive	否	boolen	空间递归查找标志；为true时将作用于指定空间及其子空间；不指定或为false时，将只作用于指定空间

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- scenePolicyID	number	情景策略ID ；情景策略的唯一标志
- scenePolicyName	string	情景策略名称
- results	object[]	情景策略执行结果
- - deviceTypeID	string	设备类型ID ；设备类型的唯一标志
- - deviceTypeName	string	设备类型名称
- - deviceInfos	object[]	设备信息列表
- - - success	boolen	结果标志；为true时表示请求成功，为false时表示请求失败
- - - deviceID	string	设备ID ；设备的唯一标志
- - - deviceName	string	设备名称
- - - result	string	结果的详细说明

错误原因：

错误码	说明
code	number

4.7.2.2.定时策略

4.7.2.2.1. 获取定时策略列表

· 请求地址： https://$host/iotp/api/open/policyMangement/platform/timing/list

功能说明：该API用于获取定时策略列表请求示例：

{

"accessToken": "accessToken",

"filter": {

"all": true,

"timingPolicyIDs": [ 5,

"timingPolicyNames": [

"*情景策略*"

] },

"paging": {

"offset": 0,

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为 “或”的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为true
- timingPolicyIDs	否	number[]	定时策略ID ；定时策略的唯一标志
- timingPolicyNames	否	string[]	定时策略名称
paging	否	object	分页参数；为空表示返回所有结果
- offset	否	number	偏移位置；从结果列表的该偏移位置开始返回，为0表示从第一个结果开始返回
- size	否	number	期望的结果数量；返回结果中将包含不超过指定数量的数据

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- paging	object	分页参数
- - nextOffset	number	下一页的偏移量；为0表示没有剩余数据
- results	object[]	定时策略列表
- - timingPolicyID	number	定时策略ID ；定时策略的唯一标志
- - timingPolicyName	string	定时策略名称
- - description	boolen	定时策略描述
- - enable	boolen	启用标志；为true时表示启用，为false时表示禁用

错误原因：

错误码	说明
code	number

4.7.2.3. 联动策略

4.7.2.3.1. 获取联动策略列表

请求地址： https://$host/iotp/api/open/policyMangement/platform/linkage/list

功能说明：获取联动策略列表请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为true
- linkagePolicyIDs	否	number[]	联动策略ID ；联动策略的唯一标志
- linkagePolicyNames	否	string[]	联动策略名称
paging	否	object	分页参数；为空表示返回所有结果
- offset	否	number	偏移位置；从结果列表的该偏移位置开始返回，为0表示从第一个结果开始返回
- size	否	number	期望的结果数量；返回结果中将包含不超过指定数量的数据

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- paging	object	分页参数
- - nextOffset	number	下一页的偏移量；为0表示没有剩余数据
- results	object[]	联动策略列表
- - linkagePolicyID	number	联动策略ID ；联动策略的唯一标志
- - linkagePolicyName	string	联动策略名称
- - description	boolen	联动策略描述
- - enable	boolen	启用标志；为true时表示启用，为false时表示禁用

错误原因：

错误码	说明
code	number

4.7.2.4. 巡检策略

4.7.2.4.1. 获取巡检策略列表

请求地址： https://$host/iotp/api/open/policyMangement/platform/inspection/list

功能说明：该API用于获取巡检策略列表请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为true
- inspectionPolicyIDs	否	number[]	巡检策略ID ；巡检策略的唯一标志
- inspectionPolicyNames	否	string[]	巡检策略名称
- inspectionPolicyTypes	否	string[]	巡检策略类型；有"space"和"device"两种；其中"space"表示空间巡检策略，"device"表示设备巡检策略
paging	否	object	分页参数；为空表示返回所有结果
- offset	否	number	偏移位置；从结果列表的该偏移位置开始返回，为0表示从第一个结果开始返回
- size	否	number	期望的结果数量；返回结果中将包含不超过指定数量的数据

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- paging	object	分页参数
- - nextOffset	number	下一页的偏移量；为0表示没有剩余数据
- results	object[]	巡检策略列表
- - inspectionPolicyID	number	巡检策略ID ；巡检策略的唯一标志
- - inspectionPolicyName	string	巡检策略名称
- - inspectionPolicyType	string	巡检策略类型；有"space"和"device"两种；其中"space"表示空间巡检策略， "device"表示设备巡检策略
- - description	boolen	巡检策略描述

错误原因：

错误码	说明
code	number

4.7.2.4.2. 执行巡检策略

请求地址： https://$host/iotp/api/open/policyMangement/platform/inspection/exec

功能说明：该API用于执行巡检策略请求示例：

请求说明：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- inspectionID	number	巡检策略ID ；巡检策略的唯一标志
- inspectionTime	string	巡检时间；时间格式为"yyyy-MM-dd HH:mm:ss"
- deviceInfos	object[]	设备信息列表
- - deviceTypeID	string	设备类型ID ；设备类型的唯一标志
- - deviceTypeName	string	设备类型名称
- - normalCount	number	正常设备数量
- - abnormalCount	number	异常设备数量
- - abnormalList	object[]	异常设备列表
- - - deviceID	string	设备ID ；设备的唯一标志
- - - deviceName	string	设备名称
- - - result	string	设备异常原因

错误原因：

错误码	说明
code	number

4.7.2.5.告警策略

4.7.2.5.1.值域告警

4.7.2.5.1.1. 获取值域告警列表

请求地址： https://$host/iotp/api/open/policyMangement/platform/alarm/range/list

功能说明：该API用于获取值域告警列表请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为true
- deviceTypeIDs	否	string[]	设备类型ID ；设备类型的唯一标志
- deviceTypeNames	否	string[]	设备类型名称
paging	否	object	分页参数；为空表示返回所有结果
- offset	否	number	偏移位置；从结果列表的该偏移位置开始返回，为0表示从第一个结果开始返回
- size	否	number	期望的结果数量；返回结果中将包含不超过指定数量的数据

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- paging	object	分页参数
- - nextOffset	number	下一页的偏移量；为0表示没有剩余数据
- results	object[]	值域告警列表
- - deviceTypeID	string	设备类型ID ；设备类型的唯一标志
- - deviceTypeName	string	设备类型名称
- - enable	boolen	启用标志；为true时表示启用，为false时表示禁用

错误原因：

错误码	说明
code	number

4.7.2.5.2.策略告警

4.7.2.5.2.1. 获取策略告警列表

请求地址： https://$host/iotp/api/open/policyMangement/platform/alarm/policy/list

功能说明：该API用于获取策略告警列表请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为 “或”的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为true
- alarmPolicyIDs	否	number[]	策略告警ID ；策略告警的唯一标志
- alarmPolicyNames	否	string[]	告警策略名称
paging	否	object	分页参数；为空表示返回所有结果
- offset	否	number	偏移位置；从结果列表的该偏移位置开始返回，为0表示从第一个结果开始返回
- size	否	number	期望的结果数量；返回结果中将包含不超过指定数量的数据

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- paging	object	分页参数
- - nextOffset	number	下一页的偏移量；为0表示没有剩余数据
- results	object[]	告警策略列表
- - alarmPolicyID	number	策略告警ID ；策略告警的唯一标志
- - alarmPolicyName	string	告警策略名称
- - description	string	告警策略描述
- - enable	boolen	启用标志；为true时表示启用，为false时表示禁用

错误原因：

错误码	说明
code	number

4.7.2.6.云守护

4.7.2.6.1.紧急联系人

4.7.2.6.1.1. 获取紧急联系人

请求地址： https://$host/iotp/api/open/policyMangement/platform/cloudGuardian/emergen cyContact/get

功能说明：该API用于获取云守护功能的紧急联系人请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- name	string	紧急联系人名称
- phone	string	紧急联系人手机号

错误原因：

错误码	说明
code	number

4.7.2.6.1.2. 设置紧急联系人

请求地址： https://$host/iotp/api/open/policyMangement/platform/cloudGuardian/emergen cyContact/set

功能说明：该API用于设置云守护功能的紧急联系人请求示例：

请求说明：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
errmsg	string	错误描述；开发者需根据code是否为0判断是否调用成功；而 errmsg仅作参考，后续可能会有变动，因此不可作为是否调用成功的判据
data	object[]	返回结果
- success	boolen	结果标志；为true时表示请求成功，为false时表示请求失败
- name	string	紧急联系人名称
- phone	string	紧急联系人手机号
- result	string	结果的详细说明

错误原因：

错误码	说明
code	number

4.7.2.6.2. 获取云守护策略列表

请求地址： https://$host/iotp/api/open/policyMangement/platform/cloudGuardian/list

功能说明：该APi用于获取云守护策略列表请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为 true
- cloudGuardianPolicyIDs	否	string[]	云守护策略ID ；云守护策略的唯一标志
- cloudGuardianPolicyNames	否	string[]	云守护策略名称
- cloudGuardianPolicyTypes	否	string[]	云守护策略类型；有"range"和"policy"两种；其中"range"表示值域告警， "policy"表示联动策略
paging	否	object	分页参数；为空表示返回所有结果
- offset	否	number	偏移位置；从结果列表的该偏移位置开始返回，为0表示从第一个结果开始返回
- size	否	number	期望的结果数量；返回结果中将包含不超过指定数量的数据

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- paging	object	分页参数
- - nextOffset	number	下一页的偏移量；为0表示没有剩余数据
- results	object[]	云守护策略列表
- - cloudGuardianPolicyID	string	云守护策略ID ；云守护策略的唯一标志
- - cloudGuardianPolicyName	string	云守护策略名称
- - cloudGuardianPolicyType	string	云守护策略类型；有"range"和"policy"两种；其中"range"表示值域告警， "policy"表示联动策略
- - enable	boolen	启用标志；为true时表示启用，为false时表示禁用

错误原因：

错误码	说明
code	number

4.8. 账户管理

4.8.1. 分组

4.8.1.1. 获取账户分组列表

请求地址： https://$host/iotp/api/open/accountManagement/group/list

功能说明：该API用于获取账户分组列表请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为 “与”的关系，同类型的筛选条件之间为“或”的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为true
- accountType	是	string	账户类型；有"local"、"dingding"、"wechat"三种，以及一卡通系统名称；其中"local"表示本地账户， "dingding"表示阿里钉钉账户，"wechat"表示企业微信账户
- groupIDs	否	number[]	账户分组ID ；账户分组的唯一标志
- groupNames	否	string[]	账户分组名称
- groupRecursive	否	boolen	分组递归查找标志；为true时将作用于指定分组及其子分组；不指定或为false时，将只作用于指定分组

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object[]	返回结果
- groupID	number	账户分组ID ；账户分组的唯一标志
- groupParentID	number	父账户分组ID ；账户分组的唯一标志
- groupName	string	账户分组名称
- groupPath	string	分组路径；由分组ID(spaceID)和斜杠(/)分隔符组成；最后一个ID为当前分组ID

错误原因：暂无

4.8.1.2. 新增账户分组

请求地址： https://$host/iotp/api/open/accountManagement/group/create

功能说明：该API用于新增账户分组请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
groupParentID	是	number	父账户分组ID ；账户分组的唯一标志
groupName	是	string	账户分组名称

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
groupID	number	账户分组ID ；账户分组的唯一标志
groupName	string	账户分组名称

错误原因：暂无

4.8.1.3. 重命名分组

请求地址： https://$host/iotp/api/open/accountManagement/group/rename

功能说明：该API用于重命名账户分组，支持批量操作请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- groupIDs	是	[]number	账户分组ID ；账户分组的唯一标志
groupName	是	string	账户分组名称

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
errmsg	string	错误描述；开发者需根据code是否为0判断是否调用成功；而 errmsg仅作参考，后续可能会有变动，因此不可作为是否调用成功的判据
data	object[]	返回结果
- success	number	结果标志；为true时表示请求成功，为false时表示请求失败
- groupID	number	账户分组ID ；账户分组的唯一标志
- groupName	string	账户分组名称
- result	string	结果的详细说明

错误原因：暂无

4.8.1.4. 移动分组

请求地址： https://$host/iotp/api/open/accountManagement/group/move

功能说明：该API用于移动账户分组，支持批量操作请求示例：

请求说明：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
errmsg	string	错误描述；开发者需根据code是否为0判断是否调用成功；而 errmsg仅作参考，后续可能会有变动，因此不可作为是否调用成功的判据
data	object[]	返回结果
- success	number	结果标志；为true时表示请求成功，为false时表示请求失败
- groupID	number	账户分组ID ；账户分组的唯一标志
- groupName	string	账户分组名称
- result	string	结果的详细说明

错误原因：暂无

4.8.1.5. 删除账户分组

请求地址： https://$host/iotp/api/open/accountManagement/group/delete

功能说明：该API用于删除账户分组，支持批量操作请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- groupIDs	否	number[]	账户分组ID ；账户分组的唯一标志

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
errmsg	string	错误描述；开发者需根据code是否为0判断是否调用成功；而 errmsg仅作参考，后续可能会有变动，因此不可作为是否调用成功的判据
data	object[]	返回结果
- success	number	结果标志；为true时表示请求成功，为false时表示请求失败
- groupID	number	账户分组ID ；账户分组的唯一标志
- groupName	string	账户分组名称
- result	string	结果的详细说明

错误原因：暂无

4.8.2. 账户

4.8.2.1. 获取账户列表

. 请求地址： https://$host/iotp/api/open/accountManagement/account/list

功能说明：该API用于获取账户列表请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
fields	否	string[]	结果域；指定返回结果中包含的内容；取值范围为"role","groups","appAuths","spaceAuths","deviceAuths"和"configs" ；其中"role"表示角色信息，"groups"表示分组信息，"appAuths"表示应用授权信息，"spaceAuths"表示空间授权信息，"deviceAuths"表示设备授权信息，"configs"表示账户关联配置
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- accountType	是	string	账户类型；有"local"、"dingding"、"wechat"三种，以及一卡通系统名称；其中"local"表示本地账户，"dingding"表示阿里钉钉账户，"wechat"表示企业微信账户
- accountIDs	否	number[]	账户ID ，账户的唯一标志
- accountNames	否	string[]	账号名称
- groupIDs	否	number[]	账户分组ID ；账户分组的唯一标志
- groupNames	否	string[]	账户分组名称
- groupRecursive	否	boolen	分组递归查找标志；为true时将作用于指定分组及其子分组；不指定或为false时，将只作用于指定分组
paging	否	object	分页参数；为空表示返回所有结果
- offset	否	number	偏移位置；从结果列表的该偏移位置开始返回，为0表示从第一个结果开始返回
- size	否	number	期望的结果数量；返回结果中将包含不超过指定数量的数据

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- paging	object	分页参数
- - nextOffset	number	下一页的偏移量；为0表示没有剩余数据
- results	object[]	账户列表
- - accountID	number	账户ID ，账户的唯一标志
- - accountName	string	账户名称
- accountType	是	string
- - accountTypeName	string	账号类型名称
- - description	string	账户描述
- - mobile	string	手机号
- - enable	boolen	启用标志；为true时表示启用，为false时表示禁用
- - role	object	角色信息
- - - roleType	string	角色类型；有"superAdmin","appAdmin","spaceAdmin"和"ordinaryUser"四种；其中"superAdmin"表示超级管理员，"appAdmin"表示应用管理员，"spaceAdmin"表示空间管理员，"ordinaryUser"表示普通用户
- - - roleName	string	角色名称
- - groups	object[]	分组信息
- - - groupID	number	账户分组ID ；账户分组的唯一标志
- - - groupName	string	账户分组名称
- - appAuths	object[]	应用授权信息
- - - appID	number	应用ID ；应用的唯一标志
- - - appName	string	应用名称
- - spaceAuths	object[]	空间授权信息
- - - spaceID	number	空间ID ；空间的唯一标志
- - - spaceName	string	空间名称
- - - spacePath	string	空间路径；由空间ID(spaceID)和斜杠(/)分隔符组成；最后一个ID为当前空间 ID
- - deviceAuths	object[]	设备授权信息
- - - deviceTypeID	string	设备类型ID ；设备类型的唯一标志
- - - deviceTypeName	string	设备类型名称
- - - device ID	string	设备ID ；设备的唯一标志
- - - deviceName	string	设备名称
- - configs	object[]	账户关联配置
- - - appTypeID	string	应用类型ID ，应用类型的唯一标志
- - - appTypeName	string	应用类型名称
- - - items	object[]	配置列表
- - - - key	string	配置类型

字段名	类型	说明
- - - - value	string	配置值

错误原因：暂无

4.8.2.2. 新增账户

· 请求地址： https://$host/iotp/api/open/accountManagement/account/create

功能说明：该API用于新增账户请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
accountName	是	string	账户名称
roleType	是	string	角色类型；有"superAdmin","appAdmin","spaceAdmin"和"ordinaryUser"四种；其中"superAdmin"表示超级管理员，"appAdmin"表示应用管理员，"spaceAdmin"表示空间管理员，"ordinaryUser"表示普通用户
groupID	是	number	账户分组ID ；账户分组的唯一标志
description	否	string	账户描述
mobile	否	string	手机号
enable	否	boolen	启用标志；为true时表示启用，为false时表示禁用
authorizations	否	object[]	授权信息
- appID	string	是	应用ID ；应用的唯一标志
- spaceIDs	否	number[]	空间ID ；空间的唯一标志
configs	否	object[]	账户关联配置
- appTypeID	是	string	应用类型ID ，应用类型的唯一标志
- items	否	object[]	配置列表
- - key	否	string	配置类型
- - value	否	string	配置值

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
errmsg	string	错误描述；开发者需根据code是否为0判断是否调用成功；而errmsg仅作参考，后续可能会有变动，因此不可作为是否调用成功的判据
data	object	返回结果
- accountID	number	账户ID ，账户的唯一标志
- accountName	string	账户名称
- result	string	结果的详细说明

错误原因：暂无

4.8.2.3. 编辑账户

. 请求地址： https://$host/iotp/api/open/accountManagement/account/update

功能说明：该API用于修改账户信息，支持批量操作请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或”的关系
- accountIDs	否	number[]	账户ID ，账户的唯一标志
- accountNames	否	string[]	账户名称
- groupIDs	否	number[]	账户分组ID ；账户分组的唯一标志
- groupNames	否	string[]	账户分组名称
- groupRecursive	否	boolen	分组递归查找标志；为true时将作用于指定分组及其子分组；不指定或为 false时，将只作用于指定分组
accountName	否	string	账户名称
roleType	否	string	角色类型；有"superAdmin","appAdmin","spaceAdmin"和"ordinaryUser"四种；其中"superAdmin"表示超级管理员，"appAdmin"表示应用管理员，"spaceAdmin"表示空间管理员，"ordinaryUser"表示普通用户
groupID	否	number	账户分组ID ；账户分组的唯一标志
description	否	string	账户描述
mobile	否	string	手机号
enable	否	boolen	启用标志；为true时表示启用，为false时表示禁用
authorizations	否	object[]	授权信息
- appID	string	是	应用ID ；应用的唯一标志
- spaceIDs	否	number[]	空间ID ；空间的唯一标志
configs	否	object[]	账户关联配置
- appTypeID	是	string	应用类型ID ，应用类型的唯一标志
- items	否	object[]	配置列表
- - key	否	string	配置类型
- - value	否	string	配置值

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
errmsg	string	错误描述；开发者需根据code是否为0判断是否调用成功；而errmsg仅作参考，后续可能会有变动，因此不可作为是否调用成功的判据
data	object[]	返回结果
- success	boolen	结果标志；为true时表示请求成功，为false时表示请求失败
- accountID	number	账户ID ，账户的唯一标识
- accountName	string	账号名称
- result	string	结果的详细说明

错误原因：暂无

4.8.2.4. 删除账户

请求地址： https://$host/iotp/api/open/accountManagement/account/delete

功能说明：该API用于删除账户，支持批量操作请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为 “与”的关系，同类型的筛选条件之间为“或”的关系
- accountIDs	否	number[]	账户ID ，账户的唯一标志
- accountNames	否	string[]	账户名称
- groupIDs	否	number[]	账户分组ID ；账户分组的唯一标志
- groupNames	否	string[]	账户分组名称
- groupRecursive	否	boolen	分组递归查找标志；为true时将作用于指定分组及其子分组；不指定或为false时，将只作用于指定分组

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
errmsg	string	错误描述；开发者需根据code是否为0判断是否调用成功；而errmsg仅作参考，后续可能会有变动，因此不可作为是否调用成功的判据
data	object[]	返回结果
- success	boolen	结果标志；为true时表示请求成功，为false时表示请求失败
- accountID	number	账户ID ，账户的唯一标志
- accountName	string	账户名称
- result	string	结果的详细说明

错误原因：暂无

4.8.3. 授权关系

4.8.3.1. 获取授权关系列表

请求地址： https://$host/iotp/api/open/accountManagement/authorization/list

功能说明：该API用于获取授权关系列表请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或” 的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为true
- deviceTypeIDs	否	string[]	设备类型ID ；设备类型的唯一标志
- deviceTypeNames	否	string[]	设备类型名称
- deviceIDs	否	string[]	设备ID ；设备的唯一标志
- deviceNames	否	string[]	设备名称
- accountIDs	否	number[]	账户ID ，账户的唯一标志
- accountNames	否	string[]	账户名称
- validity	否	object[]	授权关系有效期
- - type	是	string	授权关系有效期类型，有"permanent"和"specify"两种，其中"permanent"表示永久有效， "specify"表示在指定时间内有效
- - timeStart	否	string	开始时间；时间格式为"yyyy-MM-dd HH:mm:ss" ；为空表示不作限制
- - timeEnd	否	string	结束时间；时间格式为"yyyy-MM-dd HH:mm:ss" ；为空表示不作限制
paging	否	object	分页参数；为空表示返回所有结果
- offset	否	number	偏移位置；从结果列表的该偏移位置开始返回，为0表示从第一个结果开始返回
- size	否	number	期望的结果数量；返回结果中将包含不超过指定数量的数据

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- paging	object	分页参数
- - nextOffset	number	下一页的偏移量；为0表示没有剩余数据
- results	object[]	账户列表
- - deviceTypeID	string	设备类型ID ；设备类型的唯一标志
- - deviceTypeName	string	设备类型名称
- - deviceID	string	设备ID ；设备的唯一标志
- - deviceName	string	设备名称
- - accountID	number	账户ID ，账户的唯一标志
- - accountName	string	账户名称
- - validity	string	授权关系有效期；有"permanent"和时间点"2020-10-01 23:59:59"两种；其中"permanent"表示永久有效，"2020-10-01 23:59:59"表示有效期截止指定时间点

错误原因：暂无

4.8.3.2. 设置授权关系

请求地址： https://$host/iotp/api/open/accountManagement/authorization/set

功能说明：该API用于设置授权关系请求示例：

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
authorizations	是	object[]	授权关系列表
- deviceTypeID	是	string	设备类型ID ；设备类型的唯一标志
- deviceID	是	string	设备ID ；设备的唯一标志
- accountID	是	number	账户ID ，账户的唯一标志
- validity	是	object	授权关系有效期
- - type	是	string	授权关系有效期类型，有"permanent"和"specify"两种，其中"permanent"表示永久有效， "specify"表示在指定时间内有效
- - timeStart	否	string	开始时间；时间格式为"yyyy-MM-dd HH:mm:ss" ；为空表示不作限制
- - timeEnd	否	string	结束时间；时间格式为"yyyy-MM-dd HH:mm:ss" ；为空表示不作限制

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- success	boolen	结果标志；为true时表示请求成功，为false时表示请求失败
- deviceTypeID	string	设备类型ID ；设备类型的唯一标志
- deviceID	string	设备ID ；设备的唯一标志
- accountID	number	账户ID ，账户的唯一标志
- result	string	结果说明

错误原因：暂无

4.8.3.3. 取消授权

· 请求地址： https://$host/iotp/api/open/accountManagement/authorization/unset

功能说明：该API用于取消授权关系请求示例：

{

"type": "permanent" },

{

"type": "specify",

"timeStart": "2020-10-01 00:00:00" "timeEnd": "2020-10-01 23:59:59"

} ]

} }

请求说明：

字段名	必须	类型	说明
accessToken	是	string	第三方服务的访问授权
filter	是	object	筛选条件；用于指定该API的作用范围；必须包含至少一个筛选条件；不同类型的筛选条件之间为“与”的关系，同类型的筛选条件之间为“或” 的关系
- all	否	boolen	全选标志；设置为true时，表示作用于全部对象；为空或设置为false时，表示作用于筛选对象；当期望该API作用于全部对象时，需要显式设置为true
- authorizations	否	object[]	授权关系列表
- - deviceTypeID	否	string	设备类型ID ；设备类型的唯一标志
- - deviceID	否	string	设备ID ；设备的唯一标志
- - accountID	否	string	账户ID ，账户的唯一标志
- deviceTypeIDs	否	string[]	设备类型ID ；设备类型的唯一标志
- deviceTypeNames	否	string[]	设备类型名称
- deviceIDs	否	string[]	设备ID ；设备的唯一标志
- deviceNames	否	string[]	设备名称
- accountIDs	否	number[]	账户ID ，账户的唯一标志
- accountNames	否	string[]	账户名称
- validity	否	object[]	授权关系有效期
- - type	是	string	授权关系有效期类型，有"permanent"和"specify"两种，其中"permanent"表示永久有效， "specify"表示在指定时间内有效
- - timeStart	否	string	开始时间；时间格式为"yyyy-MM-dd HH:mm:ss" ；为空表示不作限制
- - timeEnd	否	string	结束时间；时间格式为"yyyy-MM-dd HH:mm:ss" ；为空表示不作限制

返回示例：

返回说明：

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
data	object	返回结果
- success	boolen	结果标志；为true时表示请求成功，为false时表示请求失败
- deviceTypeID	string	设备类型ID ；设备类型的唯一标志
- deviceID	string	设备ID ；设备的唯一标志
- accountID	number	账户ID ，账户的唯一标志
- result	string	结果说明

错误原因：暂无

5.9 平台管理
5.10 系统维护

4.9. 行业应用

4.9.1. 门禁系统

4.9.1.1. 预约

请求地址： https://$host/iotp/api/open/application/entranceGuard/appointment/make

功能说明：该API用于门禁系统的预约功能；使用该API ，可以为用户创建一个指定时间范围的临时授权

请求示例：

请求说明：


	字段名	必须	类型	说明
	ccessToken	是	string	第三方服务的访问授权
	ccountName	是	string	账户名称；如果该用户已经存在，则复用；否则，该接口将新创建一个临时用户
	alidity	是	object	授权有效期
	timeStart	是	string	开始时间；时间格式为"yyyy-MM-dd HH:mm:ss"
	timeEnd	是	string	结束时间；时间格式为"yyyy-MM-dd HH:mm:ss"
	dentifications	否	object[]	认证信息列表；只适用于新创建的临时用户；当 accountName指向的用户已经存在时，复用已有用户的认证信息
	key	是	string	认证类型
	value	是	string	认证信息
	uthorizations	是	object[]	授权关系列表
	eviceTypeID	是	string	设备类型ID ；设备类型的唯一标志
	deviceID	是	string	设备ID ；设备的唯一标志
返	回示例：正常返回：异常返回：

返回说明：

字段名

类型

说明

code

number

结果码；为0时表示请求成功，非0时表示请求失败

errmsg

string

错误描述；开发者需根据code是否为0判断是否调用成功；而

errmsg仅作参考，后续可能会有变动，因此不可作为是否调用成功的判据

4.9.1.2. 取消预约

请功请请	求地址： https://$host/iotp/api/open/application/entranceGuard/appointment/cancel 能说明：该API用于门禁系统的取消预约功能求示例：求说明：
	字段名	必须	类型	说明
	ccessToken	是	string	第三方服务的访问授权
	ilter	是	object	过滤项
	ccountName	否	string	用户名
	uthorizations	否	object[]	授权关系列表
	deviceTypeID	是	string	设备类型ID ；设备类型的唯一标志
	deviceID	是	string	设备ID ；设备的唯一标志
返	回示例：正常返回：异常返回：

返回说明

字段名	类型	说明
code	number	结果码；为0时表示请求成功，非0时表示请求失败
errmsg	string	错误描述；开发者需根据code是否为0判断是否调用成功；而errmsg仅作参考，后续可能会有变动，因此不可作为是否调用成功的判据
- success	boolen	结果标志；为true时表示请求成功，为false时表示请求失败
- accountName	number	用户名
- result	string	结果的详细说明

5.数据转发

5.1.设备数据转发

功能说明：配置设备数据转发之后，物联网平台会向第三方服务器以 POST 方式发送请求，并携带数据

请求示例：

返回说明：

字段名	类型	说明
token	string	数据转发配置的token ，以判断该请求是否来自平台
data	object[]	返回结果
- type_name	string	该设备的类型ID
- device_id	string	该设备的设备ID（即SN ）
- time_stamp	number	该设备本次转发的时间戳
- next_report	number	该设备上报的周期（单位： s ）；设备由于状态变更等原因，可能会提前上报
- state	object	该硬件本次转发的状态值;所有键和值均为 String 类型

5.2.告警数据转发

功能说明：配置告警数据转发之后，物联网平台会向第三方服务器以 POST 方式发送请求，并携

带数据

请求示例：

返回说明：

字段名	类型	说明
token	string	数据转发配置的token ，以判断该请求是否来自平台
type	string	数据转发类型
data	object	返回结果
- id	number	告警记录id
- alarm_mode	string	告警字段
- alarm_rank	string	告警等级
- content	string	告警内容
- device_id	string	触发设备的id
- device_name	string	触发设备名称
- notify_detail	string	推送详细内容
- policy_id	number	触发策略id
- policy_name	string	触发策略名称
- space_path	string	触发设备所在空间路径
- space_path_name	string	触发设备所在空间名称
- type_id	string	触发设备类型id
- type_name	string	触发设备类型名称

6.常见问题

1. 为什么平台需要区分【应用】

每个应用可实现不同配置，区分应用后，便于管理

2. 为什么平台需要区分【硬件】和【设备】

硬件为真实存在的设备，设备则是真实设备在平台上的虚拟化表现，可更为形象生动的展现设备数据，实现自定义筛选数据类型展示

3. 为什么有时候【控制设备】后，设备的状态还是【以前】的状态

. 下发控制后， web页面显示需要进行刷新，才可显示控制后的状态

4. 为什么策略会分为【空间策略】和【设备策略】

空间策略可以对空间下的所有设备生效，后续接入设备只要在策略空间中，则无需再次配置策略设备策略只能对已配置添加过的设备生效，后续接入设备需要手动进行配置添加

深信服自助服务平台

信锐自助服务平台

物联网平台

IOTP 开放 API 文档

1.产品简介

1.1. 物联网平台

1.2.名词解释

2. 应用案例

2.1. 获取访问授权

2.2.空间管理

2.3.设备管理

2.4.事件管理

2.5.数据分析

2.6. 智能策略

2.7.账户管理

2.8.门禁预约

2.9. 设备数据转发

2.10. 告警数据转发

3开发指南

3.1.请求地址

3.2.请求结构

3.3. 回复结构

3.4.公共参数

3.5.兼容性约定

3.6.API列表

4.开放接口

4.1. 访问授权

4.2.应用管理

4.3.空间管理

4.4.设备管理

4.5.事件管理

4.6. 数据分析

4.7.智能策略

4.8. 账户管理

4.9. 行业应用

5.数据转发

5.1.设备数据转发

5.2.告警数据转发

6.常见问题