告警中心与告警日志
大约 4 分钟
告警中心与告警日志
告警中心配置告警规则(关联规则引擎的「告警输出」动作),规则触发后生成告警日志,并按配置发送邮箱通知。
创建告警配置
| POST | /admin-api/iot/alarm-center/create |
|---|
请求数据类型 :application/json;charset=UTF-8
请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| alarmName | 告警名称 | json | true | string |
| alarmDesc | 告警描述 | json | false | string |
| alarmLevel | 告警级别,取值见系统字典 iot_alarm_level | json | false | int |
| alarmStartup | 启动状态,见系统字典 iot_common_state;1:启用 | json | false | int |
| msgNotify | 消息通知邮箱,多个用英文逗号分隔 | json | false | string |
| ruleId | 关联的规则引擎规则id,该规则动作中需包含「告警输出」 | json | false | long |
| Authorization | 认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌 | header | true | string |
响应状态
| 状态码 | 说明 |
|---|---|
| 200 | OK |
响应参数
| 参数名称 | 参数说明 | 数据类型 |
|---|---|---|
| status | 状态码,值为0正常,其他值为异常 | int |
| code | 结果同status一样,冗余字段 | int |
| data | 创建成功返回告警配置Id | long |
| msg | 状态消息 | string |
查询告警配置分页
| GET | /admin-api/iot/alarm-center/page |
|---|
请求数据类型 :application/json;charset=UTF-8
请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| pageNo | 页码,从 1 开始,示例值(1) | query | false | int32 |
| pageSize | 每页条数,最大值为 1000,示例值(10) | query | false | int32 |
| ruleId | 关联规则id | query | false | long |
| alarmName | 告警名称 | query | false | string |
| alarmLevel | 告警级别 | query | false | int |
| alarmStartup | 启动状态 | query | false | int |
| createTime | 创建时间时间范围,示例值(2026-10-01 00:00:00 - 2026-10-25 23:59:59) | query | false | array[datetime] |
| Authorization | 认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌 | header | true | string |
响应状态
| 状态码 | 说明 |
|---|---|
| 200 | OK |
响应参数
| 参数名称 | 参数说明 | 数据类型 |
|---|---|---|
| status | 状态码,值为0正常,其他值为异常 | int |
| code | 结果同status一样,冗余字段 | int |
| data | 分页数据 | object |
| ---total | 返回结果条数 | int |
| ---list | 返回数据列表 | array |
| ------id | 告警配置id | long |
| ------ruleId | 关联规则id | long |
| ------ruleName | 规则名称(服务端填充) | string |
| ------ruleDescription | 规则描述(服务端填充) | string |
| ------alarmName | 告警名称 | string |
| ------alarmDesc | 告警描述 | string |
| ------alarmLevel | 告警级别 | int |
| ------alarmStartup | 启动状态;1:启用 | int |
| ------msgNotify | 消息通知邮箱 | string |
| ------createTime | 创建时间 | string |
| msg | 状态消息 | string |
更新 / 删除 / 详情
| 方法 | 路径 | 说明 |
|---|---|---|
| PUT | /admin-api/iot/alarm-center/update | 更新告警配置;告警配置无独立的启停接口,启动状态通过本接口修改 alarmStartup 字段 |
| DELETE | /admin-api/iot/alarm-center/delete | 删除告警配置,query 参数:id(必填) |
| GET | /admin-api/iot/alarm-center/get | 查询告警配置详情,query 参数:id(必填) |
查询告警日志分页
| GET | /admin-api/iot/alarm-log/page |
|---|
请求数据类型 :application/json;charset=UTF-8
请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| pageNo | 页码,从 1 开始,示例值(1) | query | false | int32 |
| pageSize | 每页条数,最大值为 1000,示例值(10) | query | false | int32 |
| alarmId | 告警配置id | query | false | long |
| alarmContent | 告警内容 | query | false | string |
| hasHandle | 处理情况;0:未处理;1:已处理 | query | false | int |
| handleBy | 处理者 | query | false | string |
| handleTime | 处理时间时间范围 | query | false | array[datetime] |
| createTime | 创建时间时间范围 | query | false | array[datetime] |
| Authorization | 认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌 | header | true | string |
响应状态
| 状态码 | 说明 |
|---|---|
| 200 | OK |
响应参数
| 参数名称 | 参数说明 | 数据类型 |
|---|---|---|
| status | 状态码,值为0正常,其他值为异常 | int |
| code | 结果同status一样,冗余字段 | int |
| data | 分页数据 | object |
| ---total | 返回结果条数 | int |
| ---list | 返回数据列表 | array |
| ------id | 告警日志id | long |
| ------alarmId | 告警配置id | long |
| ------alarmContent | 告警内容 | string |
| ------hasHandle | 处理情况;0:未处理;1:已处理 | int |
| ------handleSuggestion | 处理建议 | string |
| ------handleBy | 处理者 | string |
| ------handleTime | 处理时间 | string |
| ------triggerData | 触发数据,JSON字符串 | string |
| ------createTime | 创建时间 | string |
| msg | 状态消息 | string |
处理告警日志
| PUT | /admin-api/iot/alarm-log/update |
|---|
请求数据类型 :application/json;charset=UTF-8
请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| id | 告警日志id | json | true | long |
| alarmId | 告警配置id | json | false | long |
| hasHandle | 处理情况,处理动作传 1 | json | false | int |
| handleSuggestion | 处理建议 | json | false | string |
| handleBy | 处理者 | json | false | string |
| Authorization | 认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌 | header | true | string |
响应状态
| 状态码 | 说明 |
|---|---|
| 200 | OK |
响应参数
| 参数名称 | 参数说明 | 数据类型 |
|---|---|---|
| status | 状态码,值为0正常,其他值为异常 | int |
| code | 结果同status一样,冗余字段 | int |
| data | 处理成功返回true | boolean |
| msg | 状态消息 | string |
提示
告警配置必须关联到规则引擎,且该规则的动作中需包含「告警输出」,规则触发时才会生成告警日志并发送邮箱通知。规则引擎配置见规则引擎。