简体中文
简体中文
English
联系我们
注册
登录
语言
简体中文
简体中文
English
联系我们
登录
注册
返回主站
layout空间导航

设备报警设置

更新时间:2021-09-18 08:41:16下载pdf

通过以下 API 查询报警异常日志。

请求方式 API 描述
GET /v1.0/illumination/sysalarm/alarms 筛选项目下报警/异常信息
GET /v1.0/illumination/sysalarm/disalarm/{projectId}/{relationId} 将指定报警消息标记为解除异常

筛选项目下报警/异常信息

功能描述

筛选项目下报警/异常信息。

接口地址

GET /v1.0/illumination/sysalarm/alarms

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目id
alarmType int body 报警类型
  • 1:报警
  • 2:异常
roomIds String[] body 房间id集合
categories int[] body 类型集合
start long body 开始时间 13 位时间戳
end long body 结束时间 13 位时间戳
keyword String body 关键词查询
disalarm int body 筛选是否已解除警报
page int body 当前页,最小为1,默认为1
pageSize int body 页数量,最大为10000,默认为10

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功:(true:成功,false:失败)
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

{ "total": "int", "list": [ { "id": "long //id", "customEventId": "String //自定义事件id", "relationId": "String //本表唯一标识", "category": "String //类别", "categoryCode": "String //类别代码 1-自定义报警 2-照明 3-电工 4-安防", "projectId": "String //所属项目id", "roomId": "String //所属房间id", "roomName": "String //所属房间名称", "deviceId": "String //设备id", "deviceName": "String //设备名称", "deviceTopCategory": "String //设备类别", "alarmEvent": "String //报警事件", "alarmTime": "long //报警产生时间", "alarmType": "int //报警类型 1-报警 2-异常", "alarmSubType": "int //报警/异常子类型。0-自定义事件报警/异常, 1-设备离线", "disalarm": "boolean //是否解除警报", "disalarmTime": "long //报警解除时间" } ] }

请求示例

{ "alarmType": "报警类型 1-报警 2-异常", "projectId": "项目id" }

响应示例

{ "total": "25", "list": [ { "id": "1", "customEventId": "12231562452233", "relationId": "126762133346134", "category": "自定义报警", "categoryCode": "1", "projectId": "12447741234544", "roomId": "1245690043468883", "roomName": "测试空间", "deviceId": "146894336893225", "deviceName": "测试设备", "deviceTopCategory": "zm", "alarmEvent": "测试报警", "alarmTime": "1615461449136", "alarmType": "1", "alarmSubType": "0", "disalarm": "false" } ] }

将指定报警消息标记为解除异常

功能描述

将指定报警消息标记为解除异常。

接口地址

GET /v1.0/illumination/sysalarm/disalarm/{projectId}/{relationId}

请求参数

参数名 类型 参数类型 说明 是否必需
relationId String url 报警记录id
projectId String url 项目id

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功:(true:成功,false:失败)
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

boolean{}

请求示例

{ "relationId": "报警记录id" }

响应示例

true

错误码

以下为该接口常见的业务异常,更多的异常错误,请参见全局错误码

错误码 说明
500 系统错误