跳到主要内容

get_custom_alarm_level 获取告警级别

POST /api/v1/alarm/get_custom_alarm_level​

描述​

获取告警级别接口，用于获取告警级别。告警级别包括：critical, major, minor, event。

访问权限​

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

alarm:get_custom_alarm_level

JSON参数​

请求参数如下：

{
  "alarmMessage": "alarm.message1"
}

请求示例：

{
  "alarmMessage": "power1.off"
}

响应结果​

请求返回的HTTP状态码为200

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

{
  "success": true|false,
  "data": {
    "alarmMessage": "alarmMessage1",
    "level": string,
    "module": string
  },
  "errorCode": "option string",
  "errorMessage": "option string",
  "showType": 0|1|2|4|9,
  "traceId": "option string"
}
提示
  • level: 告警级别，包括：critical, major, minor, event
  • module: 告警模块 例如：PTP, POWER, GNSS, PLL, PTP, NTP, NETWORK, SYSTEM, CLOCK, PPS_TOD

正确结果示例：

{
  "success": true,
  "data": { 
    "level": "critical",
    "module": "POWER"
  }
}

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

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

错误码​

错误码说明错误信息显示类型
40007告警消息不能为空no.blank.params4
40007告警消息不存在alarm.message.not.exist4