系统告警查询接口用于从监控系统查询告警信息,支持分页查询和多维度过滤。
默认接口请求频率限制:20次/秒
REST URL
GET /api/rest/external/v1/ops/system/alarm/query?enterpriseId=xxx&level=xxx&status=xxx&startTime=xxxx&endTime=xxxx&pageIndex=0&pageSize=20
请求参数说明
参数 | 参数类型 | 参数位置 | 是否必须 | 默认值 | 说明 | 初始平台 |
enterpriseId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 | 分区云5.2-20260327 公有云不存在 |
pageIndex | int | Query | 否 | 0 | 页码,默认为0 | 分区云5.2-20260327 公有云不存在 |
pageSize | int | Query | 否 | 20 | 每页大小,默认为20,最大不能超过100 | 分区云5.2-20260327 公有云不存在 |
startTime | Long | Query | 否 | 最近 6 小时 | 时间戳,最大 30 天 | 分区云5.2-20260327 公有云不存在 |
endTime | Long | Query | 否 | 当前时间 | 时间戳 | 分区云5.2-20260327 公有云不存在 |
level | String | Query | 否 | 无 | 告警级别。 S1:一级告警,S2:二级告警,S3:三级告警。一级是严重告警 | 分区云5.2-20260327 公有云不存在 |
status | String | Query | 否 | 无 | 状态。已触发:on。已恢复:off | 分区云5.2-20260327 公有云不存在 |
返回结果示例:
成功时返回200,失败时返回小鱼RESTAPI错误码
{
"page": 1,
"pageTotal": 5,
"rowsTotal": 100,
"rows": 20,
"list": [
{
"ruleName": "01030001-主机磁盘使用率大于85",
"alarmLevel": "S1",
"alarmStatus": "已触发",
"triggerTime": 1700125400000,
"triggerValue": "85.03283",
"frequency": "60秒",
"duration": "60秒",
"source": "dev-192.10.21.111",
"eventId": 68148,
"firstTriggerTime": 1700123600000,
"tags": [
"container=logcenter-filebeat",
"pod=logcenter-filebeat-7sp5r",
"rulename=06010001-服务cpu使用率连续5分钟超过85%"
],
}
]
}成功时返回结果数据,失败时返回小鱼RESTAPI错误码
返回参数说明
参数名称 | 说明 |
ruleName | 规则标题 |
alarmLevel | 告警级别(S1/S2/S3) |
alarmStatus | 事件状态(已触发/已恢复) |
triggerTime | 触发时间(Unix毫秒时间戳) |
triggerValue | 触发时的指标值 |
frequency | 执行频率 |
duration | 持续时长(告警需持续多长时间才触发) |
source | 告警来源 |
eventId | 事件ID |
tags | 事件标签 |
firstTriggerTime | 首次触发时间(Unix毫秒时间戳) |