Skip to main content

custom_level_list 获取自定义告警级别列表

POST /api/v1/alarm/custom_level_list

描述

获取告警级别列表接口,用于配置自定义告警级别。告警级别包括:critical, major, minor, event。

访问权限

需要登录,具备以下权限:

alarm:custom_level_list

JSON参数

请求最新n条数据:

{}

响应结果

请求返回的HTTP状态码为200

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

{
"success": true|false,
"data"?: [
{
"alarmMessage": string,
"level": "critical"|"major"|"minor"|"event",
"module": string,
},
{
"alarmMessage": string,
"level": "critical"|"major"|"minor"|"event",
"module": string,
},
...
],
"errorCode"?: "option string",
"errorMessage"?: "option string",
"showType"?: 0|1|2|4|9,
"traceId"?: "option string"
}
tip
  • alarmMessage: 告警信息,告警信息的key为告警描述,值为告警级别和模块。
  • level: 告警级别,包括:critical, major, minor, event
  • module: 告警模块 例如:PTP, POWER, GNSS, PLL, PTP, NTP, NETWORK, SYSTEM, CLOCK, PPS_TOD

告警信息列表:

级别Modulekey描述说明
criticalPOWERpower1.off电源1掉电
criticalPOWERpower2.off电源2掉电
eventPOWERpower1.on电源1上电
eventPOWERpower2.on电源2上电
criticalPLLpll.errorPLL故障
minorPLLenter.fixedPLL进入快捕模式
majorPLLenter.holdoverPLL进入Holdover模式
majorPLLenter.freerunPLL进入Freerun模式
minorPLLenter.followPLL进入Follow模式
eventPLLenter.lockPLL进入Lock模式
eventPLLenter.adjustPLL进入Adjust模式
eventPLLenter.locledPLL进入Locled模式
minorPTPptp.state.masterPTP状态为Masterdetail 中添加端口号
minorPTPptp.state.slavePTP状态为Slavedetail 中添加端口号
criticalNTPntp.errorNTP故障detail 中添加端口号
eventNETWORKLinkUpPTP以太网连接detail 中添加端口号
minorNETWORKLinkDownPTP以太网断开detail 中添加端口号
eventNETWORKptp.sfp.linkupPTP光模块连接detail 中添加端口号
minorNETWORKptp.sfp.linkdownPTP光模块断开detail 中添加端口号
eventGNSSgnss.find.signalGNSS找到信号detail 中添加端口号
majorGNSSgnss.lost.signalGNSS丢失信号detail 中添加端口号
majorSYSTEMe1.lost.signalE1丢失信号detail 中添加端口号
eventSYSTEMe1.find.signalE1找到信号detail 中添加端口号
majorSYSTEMirig.b.lost.signalIRIG-B丢失信号detail 中添加端口号
eventSYSTEMirig.b.find.signalIRIG-B找到信号detail 中添加端口号
majorPTPptp.lost.signalPTP丢失信号detail 中添加端口号
eventPTPptp.find.signalPTP找到信号detail 中添加端口号
eventSYSTEMsystem.reboot系统重启
majorSYSTEMColdStart系统冷启动
majorSYSTEMWarmStart系统热启动
eventSYSTEMsystem.upgrade系统升级detail 中添加版本号
eventSYSTEMsystem.login用户登录detail 中添加用户名
majorSYSTEMAuthenticationFailure用户登录失败detail 中添加用户名
eventSYSTEMsystem.shutdown系统关机
eventSYSTEMsystem.startup系统启动
eventCLOCKclock.source.switch时钟源切换detail 中添加源名称
criticalSYSTEMmain.control.board.status.switch主控板工作状态切换detail 中添加切换到的状态
criticalSYSTEMboth.main.control.board.unavailable两个主控板均不可用
eventSYSTEMmain.control.board.restored.available主控板恢复可用
eventSYSTEMboard.insertion业务板插入detail 中添加插入位置编号和类型
eventSYSTEMboard.extraction业务板拔出detail 中添加插入位置编号和类型
criticalSYSTEMboard.heart.beat.timeout业务板心跳超时detail 中添加插入位置编号和类型
eventSYSTEMboard.heart.beat.timeout.recovery业务板心跳超时恢复detail 中添加插入位置编号和类型
eventSYSTEMmain.control.board.insertion主控板插入detail 中添加插入位置编号
criticalSYSTEMmain.control.board.extraction主控板拔出detail 中添加插入位置编号
eventGNSSantenna.status.normal天线状态正常detail 中添加天线编号
criticalGNSSantenna.status.uninitialized天线未初始化detail 中添加天线编号
criticalGNSSantenna.status.open天线状态开路detail 中添加天线编号
criticalGNSSantenna.status.short.circuit天线状态短路detail 中添加天线编号
criticalGNSSantenna.status.unknown天线状态未知detail 中添加天线编号
majorGNSSsatellites.too.few卫星数量过少detail 中添加天线编号、告警星系及当前可用的卫星数量
eventGNSSsatellites.too.few.recovery卫星数量恢复正常detail 中添加天线编号
eventGNSSgnss.pps.valid检测到卫星PPS有效detail 中添加天线编号
majorGNSSgnss.pps.invalid检测到卫星PPS无效detail 中添加天线编号
criticalGNSSgnss.receiver.malfunction卫星接收机故障detail 中添加天线编号
criticalPPS_TODpps.tod.lost.signalPPS_TOD丢失信号
eventPPS_TODpps.tod.find.signalPPS_TOD找到信号
majorPPS_TODsecond.pulse.status.below.thresholdPPS_TOD秒脉冲状态低于门限值
eventPPS_TODsecond.pulse.status.below.threshold.recoveryPPS_TOD秒脉冲状态恢复
majorPPS_TODsecond.pulse.status.invalidPPS_TOD秒脉冲状态无效当前的秒脉冲状态
minorPPS_TODpps.tod.in.format.errorPPS_TOD_IN报文格式与配置不符config 格式,actual 格式
majorCLOCKfrequency.source.ssm.level.degradation频率源输入参考源SSM等级劣化ptp/gnss1/gnss2
majorCLOCKtime.source.clock.class.degradation时间源输入参考源Clock Class等级劣化ptp/gnss1/gnss2
majorCLOCKfrequency.source.lost.signal频率源输入信号丢失ptp/gnss1/gnss2/synce
minorCLOCKfrequency.source.deviates.exceed.threshold频率源偏差超过门限值ptp/gnss1/gnss2/synce
majorCLOCKtime.source.deviates.exceed.threshold时间源偏差超过门限值ptp/gnss1/gnss2
eventCLOCKtime.source.switching时间源倒换ptp/gnss1/gnss2
eventCLOCKfrequency.source.switching频率源倒换ptp/gnss1/gnss2/synce
eventPTPptp.slave.port.switchingSlave端口倒换detail 中添加端口号
eventPTPptp.grandmaster.clock.switchingGM时钟切换detail 中添加端口号
majorPTPptp.announce.message.lostAnnounce报文丢失detail 中添加端口号
majorPTPptp.sync.delay_resp.message.lostSync或Delay_Resp报文丢失detail 中添加端口号
级别由用户配置CLOCKsignal.deviates.exceed.threshold信号鉴相值超过门限值<信号名称> current phase is <鉴相值>
eventCLOCKfrequency.source.signal.found频率源信号找到detail 中添加端口号
majorNTPntp.input.disconnectedNTP输入断开detail 中添加源IP地址
eventNTPntp.input.connectedNTP输入连接detail 中添加源IP地址
majorNTPntp.client.sync.timeoutNTP客户端同步超时detail 中添加客户端的IP地址
majorCLOCKfrequency.source.signal.lost频率源信号丢失detail 中添加端口号
minorPTPptp.message.information.defectPTP报文信息缺陷detail 中添加端口号
minorCLOCKe1.input.channel.changeE1输入通道切换detail 中添加端口号
minorCLOCKptp.port.faultyPTP端口变为FAULT状态detail 中添加端口号
minorCLOCKptp.port.listeningPTP端口变为LISTENING状态detail 中添加端口号
majorCLOCKptp.master.offset.exceeded同步上游主时钟偏移超过阈值detail 中添加端口号
minorCLOCKptp.master.no.trafficPTP主端口没有发送报文detail 中添加端口号
minorCLOCKptp.slave.no.trafficPTP从端口没有收到报文detail 中添加端口号
eventCLOCKptp.port.uncalibratedPTP端口未校准detail 中添加端口号
eventCLOCKclock.source.mode.changed时钟源模式改变detail 中添加端口号

正确结果示例:

{
"success": true,
"data": {
"power1.off": {
"level": "critical",
"module": "POWER"
},
"power2.off": {
"level": "critical",
"module": "POWER"
},
"power1.on": {
"level": "event",
"module": "POWER"
},
...
"frequency.source.signal.found": {
"level": "event",
"module": "CLOCK"
},
}
}

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

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

错误码

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

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