设备告警信息

本文档描述如何通过以下 API 查询设备告警。

请求方式	API	描述
POST	/v1.0/cloud/illume/sysalarm/alarms	筛选项目下设备告警/自定义告警
GET	/v1.0/illumination/sysalarm/disalarm/{projectId}/{relationId}	将指定告警消息标记为解除告警

筛选项目下设备告警/自定义告警

功能描述

筛选项目下设备告警/自定义告警。

接口地址

POST /v1.0/cloud/illume/sysalarm/alarms

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	String	body	项目 ID	是
alarmType	int	body	告警类型 1：自定义告警 2：设备告警	是
roomIds	List< String >	body	房间 ID 集合	否
deviceName	String	body	设备名称	否
deviceId	String	body	设备 ID	否
lastAlarmStart	long	body	最后告警开始时间 13 位时间戳	否
lastAlarmEnd	long	body	最后告警结束时间 13 位时间戳	否
disalarm	int	body	告警状态 -1：全部 1：已解除 0：未解除，如果未指定，默认返回 0	否
page	int	body	当前页，最小为 1	是
pageSize	int	body	分页页面大小，最大值为 100，建议值为 20	是

返回参数

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

result 参数说明

{
  "result":{
    "list":[
      {
        "relationId": "String //告警记录 ID",
        "projectId": "String //所属项目 ID",
        "roomId": "String //所属房间 ID",
        "roomName": "String //所属房间名称",
        "deviceId": "String //设备 ID",
        "deviceName": "String //设备名称",
        "deviceTopCategory": "String //设备类别",
        "alarmEvent": "String //告警事件描述",
        "alarmType": "int //告警类型，1：自定义告警，2：设备告警",
        "disalarm": "boolean //告警状态，true：解除，false：未解除",
        "disalarmTime": "long //告警解除时间",
        "lastAlarmTime":"long //最后发生告警时间"
      }
    ],
    "total":1
  },
  "success":true,
  "t":1702459727383,
  "tid":"12444f864fbcabd0"
}

请求示例

{
  "alarmType": "告警类型，1：自定义告警，2：设备告警",
  "projectId": "项目 ID",
  "disalarm": "告警状态，-1：全部，1：已解除，0：未解除",
  "page": 1,
  "pageSize":20
}

响应示例

{
  "result":{
    "list":[
      {
        "relationId": "126762133346134",
        "projectId": "12447741234544",
        "roomId": "1245690043468883",
        "roomName": "测试空间",
        "deviceId": "146894336893225",
        "deviceName": "测试设备",
        "deviceTopCategory": "zm",
        "alarmEvent": "离线",
        "alarmType": 2,
        "disalarm": false,
        "disalarmTime": 0,
        "lastAlarmTime":1615461449136,
        "alarmOccurCount": 1
      }
    ],
    "total":1
  },
  "success":true,
  "t":1702459727383,
  "tid":"12444f864fbcabd0"
}

将指定告警消息标记为解除告警

功能描述

将指定告警消息标记为解除告警。

接口地址

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	系统错误