alarm_list 获取告警列表

POST /api/v1/alarm/alarm_list

描述

获取告警列表接口，用于获取告警列表信息。 最多返回最近的n条，最多可以获得500条。

访问权限

需要登录，具备以下权限：

alarm:alarm_list

JSON参数

请求最新n条数据：

{
  "count": number
}

响应结果

请求返回的HTTP状态码为200

返回结果为JSON格式的数据，您可以通过解析JSON数据来获取API调用的结果信息。结构如下：

{
  "success": true|false,
  "data"?: { 
    "list": [
      "v3,alarmId, deviceId, utcTime, level, module, description, detail",
      "v3,alarmId, deviceId, utcTime, level, module, description, detail",
      ...
    ]
  },
  "errorCode"?: "option string",
  "errorMessage"?: "option string",
  "showType"?: 0|1|2|4|9,
  "traceId"?: "option string"
}

提示

• list: 告警列表数据，每条数据格式为："v3,alarmId, deviceId, utcTime, level, module, description, detail".
• v3: 版本号，用于区分不同版本的告警数据。
• alarmId: 告警编号，唯一标识告警信息。
• deviceId: 设备ID
• utcTime: 告警时间，UTC时间戳, 单位为秒，页面显示时候转换为本地时间。
• level: 告警级别，包括：critical, major, minor, event
• module: 告警模块 例如：PTP, POWER, GNSS, PLL, PTP, NTP, NETWORK, SYSTEM, CLOCK, PPS_TOD
• description: 告警描述。采用英文描述，单词之间用.分隔。便于前端国际化处理。
• detail: 告警详细信息，用于前端展示告警详细信息。比如登录失败时候，可以记录登录失败的用户名。

告警信息列表：

级别	Module	key	描述	说明
critical	POWER	power1.off	电源1掉电
critical	POWER	power2.off	电源2掉电
event	POWER	power1.on	电源1上电
event	POWER	power2.on	电源2上电
critical	PLL	pll.error	PLL故障
minor	PLL	enter.fixed	PLL进入快捕模式
major	PLL	enter.holdover	PLL进入Holdover模式
major	PLL	enter.freerun	PLL进入Freerun模式
minor	PLL	enter.follow	PLL进入Follow模式
event	PLL	enter.lock	PLL进入Lock模式
event	PLL	enter.adjust	PLL进入Adjust模式
event	PLL	enter.locled	PLL进入Locled模式
minor	PTP	ptp.state.master	PTP状态为Master	detail 中添加端口号
minor	PTP	ptp.state.slave	PTP状态为Slave	detail 中添加端口号
critical	NTP	ntp.error	NTP故障	detail 中添加端口号
event	NETWORK	LinkUp	PTP以太网连接	detail 中添加端口号
minor	NETWORK	LinkDown	PTP以太网断开	detail 中添加端口号
event	NETWORK	ptp.sfp.linkup	PTP光模块连接	detail 中添加端口号
minor	NETWORK	ptp.sfp.linkdown	PTP光模块断开	detail 中添加端口号
event	GNSS	gnss.find.signal	GNSS找到信号	detail 中添加端口号
major	GNSS	gnss.lost.signal	GNSS丢失信号	detail 中添加端口号
major	SYSTEM	e1.lost.signal	E1丢失信号	detail 中添加端口号
event	SYSTEM	e1.find.signal	E1找到信号	detail 中添加端口号
major	SYSTEM	irig.b.lost.signal	IRIG-B丢失信号	detail 中添加端口号
event	SYSTEM	irig.b.find.signal	IRIG-B找到信号	detail 中添加端口号
major	PTP	ptp.lost.signal	PTP丢失信号	detail 中添加端口号
event	PTP	ptp.find.signal	PTP找到信号	detail 中添加端口号
event	SYSTEM	system.reboot	系统重启
major	SYSTEM	ColdStart	系统冷启动
major	SYSTEM	WarmStart	系统热启动
event	SYSTEM	system.upgrade	系统升级	detail 中添加版本号
event	SYSTEM	system.login	用户登录	detail 中添加用户名
major	SYSTEM	AuthenticationFailure	用户登录失败	detail 中添加用户名
event	SYSTEM	system.shutdown	系统关机
event	SYSTEM	system.startup	系统启动
event	CLOCK	clock.source.switch	时钟源切换	detail 中添加源名称
critical	SYSTEM	main.control.board.status.switch	主控板工作状态切换	detail 中添加切换到的状态
critical	SYSTEM	both.main.control.board.unavailable	两个主控板均不可用
event	SYSTEM	main.control.board.restored.available	主控板恢复可用
event	SYSTEM	board.insertion	业务板插入	detail 中添加插入位置编号和类型
event	SYSTEM	board.extraction	业务板拔出	detail 中添加插入位置编号和类型
critical	SYSTEM	board.heart.beat.timeout	业务板心跳超时	detail 中添加插入位置编号和类型
event	SYSTEM	board.heart.beat.timeout.recovery	业务板心跳超时恢复	detail 中添加插入位置编号和类型
event	SYSTEM	main.control.board.insertion	主控板插入	detail 中添加插入位置编号
critical	SYSTEM	main.control.board.extraction	主控板拔出	detail 中添加插入位置编号
event	GNSS	antenna.status.normal	天线状态正常	detail 中添加天线编号
critical	GNSS	antenna.status.uninitialized	天线未初始化	detail 中添加天线编号
critical	GNSS	antenna.status.open	天线状态开路	detail 中添加天线编号
critical	GNSS	antenna.status.short.circuit	天线状态短路	detail 中添加天线编号
critical	GNSS	antenna.status.unknown	天线状态未知	detail 中添加天线编号
major	GNSS	satellites.too.few	卫星数量过少	detail 中添加天线编号、告警星系及当前可用的卫星数量
event	GNSS	satellites.too.few.recovery	卫星数量恢复正常	detail 中添加天线编号
event	GNSS	gnss.pps.valid	检测到卫星PPS有效	detail 中添加天线编号
major	GNSS	gnss.pps.invalid	检测到卫星PPS无效	detail 中添加天线编号
critical	GNSS	gnss.receiver.malfunction	卫星接收机故障	detail 中添加天线编号
critical	PPS_TOD	pps.tod.lost.signal	PPS_TOD丢失信号
event	PPS_TOD	pps.tod.find.signal	PPS_TOD找到信号
major	PPS_TOD	second.pulse.status.below.threshold	PPS_TOD秒脉冲状态低于门限值
event	PPS_TOD	second.pulse.status.below.threshold.recovery	PPS_TOD秒脉冲状态恢复
major	PPS_TOD	second.pulse.status.invalid	PPS_TOD秒脉冲状态无效	当前的秒脉冲状态
minor	PPS_TOD	pps.tod.in.format.error	PPS_TOD_IN报文格式与配置不符	config 格式，actual 格式
major	CLOCK	frequency.source.ssm.level.degradation	频率源输入参考源SSM等级劣化	ptp/gnss1/gnss2
major	CLOCK	time.source.clock.class.degradation	时间源输入参考源Clock Class等级劣化	ptp/gnss1/gnss2
major	CLOCK	frequency.source.lost.signal	频率源输入信号丢失	ptp/gnss1/gnss2/synce
minor	CLOCK	frequency.source.deviates.exceed.threshold	频率源偏差超过门限值	ptp/gnss1/gnss2/synce
major	CLOCK	time.source.deviates.exceed.threshold	时间源偏差超过门限值	ptp/gnss1/gnss2
event	CLOCK	time.source.switching	时间源倒换	ptp/gnss1/gnss2
event	CLOCK	frequency.source.switching	频率源倒换	ptp/gnss1/gnss2/synce
event	PTP	ptp.slave.port.switching	Slave端口倒换	detail 中添加端口号
event	PTP	ptp.grandmaster.clock.switching	GM时钟切换	detail 中添加端口号
major	PTP	ptp.announce.message.lost	Announce报文丢失	detail 中添加端口号
major	PTP	ptp.sync.delay_resp.message.lost	Sync或Delay_Resp报文丢失	detail 中添加端口号
级别由用户配置	CLOCK	signal.deviates.exceed.threshold	信号鉴相值超过门限值	<信号名称> current phase is <鉴相值>
event	CLOCK	frequency.source.signal.found	频率源信号找到	detail 中添加端口号
major	NTP	ntp.input.disconnected	NTP输入断开	detail 中添加源IP地址
event	NTP	ntp.input.connected	NTP输入连接	detail 中添加源IP地址
major	NTP	ntp.client.sync.timeout	NTP客户端同步超时	detail 中添加客户端的IP地址
event	NTP	ntp.input.changed	NTP输入源改变	detail 中添加源IP地址
major	CLOCK	frequency.source.signal.lost	频率源信号丢失	detail 中添加端口号
minor	PTP	ptp.message.information.defect	PTP报文信息缺陷	detail 中添加端口号
minor	CLOCK	e1.input.channel.change	E1输入通道切换	detail 中添加端口号
minor	CLOCK	ptp.port.faulty	PTP端口变为FAULT状态	detail 中添加端口号
minor	CLOCK	ptp.port.listening	PTP端口变为LISTENING状态	detail 中添加端口号
major	CLOCK	ptp.master.offset.exceeded	同步上游主时钟偏移超过阈值	detail 中添加端口号
minor	CLOCK	ptp.master.no.traffic	PTP主端口没有发送报文	detail 中添加端口号
minor	CLOCK	ptp.slave.no.traffic	PTP从端口没有收到报文	detail 中添加端口号
event	CLOCK	ptp.port.uncalibrated	PTP端口未校准	detail 中添加端口号
event	CLOCK	clock.source.mode.changed	时钟源模式改变	detail 中添加端口号
critical	CLOCK	E100.board.unavailable	E100时钟板不可用，时钟板硬件异常	No Detected/Detected Error/Try Recovering

正确结果示例：

{
  "success": true,
  "data": {
    "list": [
      "v3,123122,56:34:23:12:01:00,1577808000,critical,POWER,power1.off,",
      "v3,123123,56:34:23:12:01:00,1577808000,critical,POWER,power2.off,power2",
      ...
    ]
  }
}

错误结果示例, 返回false时候需要带上错误码和错误信息：

{
  "success": false,
  "errorCode": "40000",
  "errorMessage": "no.blank.params",
  "showType": 4
}

错误码

错误码	说明	错误信息	显示类型
40000	没有参数	no.blank.params	4

提示

4 表示弹框提示错误信息。