---
# System prepended metadata

title: Alarm API Document

---

# Alarm API Document

## Alarm message
### Payload
```json
{
  "Subject": "major alarm occurred",
  "Timestamp": 1611905494,
  "DeviceId": "1/1/1/1/20",
  "Rack": 1,
  "Shelf": 1,
  "Slot": 1,
  "Port": 1,
  "UserModem": 20,
  "Message": "ONT is inactive",
  "Raw": "Jan 10 19:01:16 cns-backhaul-001 rOT1[299]: 70/01/10 19:01:16 major alarm occurred for ont 1/1/1/1/20 (service affecting) : ONT is inactive"
}
```
```json
{
  "Subject": "major alarm cleared",
  "Timestamp": 1611905594,
  "DeviceId": "1/1/1/1/20",
  "Rack": 1,
  "Shelf": 1,
  "Slot": 1,
  "Port": 1,
  "UserModem": 20,
  "Message": "ONT is inactive",
  "Raw": "Jan 10 18:59:31 cns-backhaul-001 rOT1[299]: 70/01/10 18:59:31 major alarm cleared for ont 1/1/1/1/20 (service affecting) : ONT is inactive"
}
```
```json
{
  "Subject": "major alarm occurred",
  "Timestamp": 1611905336,
  "DeviceId": "1/1/1/1",
  "Rack": 1,
  "Shelf": 1,
  "Slot": 1,
  "Port": 1,
  "Message": "PON Loss of Signal",
  "Raw": "Jan 10 18:59:31 cns-backhaul-001 rOT1[299]: 70/01/10 18:59:31 major alarm occurred for pon 1/1/1/1 (service affecting) : PON Loss of Signal"
}
```
```json
{
  "Subject": "major alarm cleared",
  "Timestamp": 1611905376,
  "DeviceId": "1/1/1/1",
  "Rack": 1,
  "Shelf": 1,
  "Slot": 1,
  "Port": 1,
  "Message": "PON Loss of Signal",
  "Raw": "Jan 10 19:00:36 cns-backhaul-001 rOT1[299]: 70/01/10 19:00:36 major alarm cleared for pon 1/1/1/1 (service affecting) : PON Loss of Signal"
}
```
```json
{
  "Subject": "critical alarm occurred",
  "Timestamp": 1611905123,
  "Slot": 1,
  "DeviceId": "1/1/1",
  "Message": "Ethernet Link Down alarm",
  "Raw": "Jan 10 19:06:18 cns-backhaul-001 rOT1[299]: 70/01/10 19:06:18 critical alarm occurred for nt-a:xfp:1 (service affecting) : Ethernet Link Down alarm"
}
```
```json
{
  "Subject": "critical alarm cleared",
  "Timestamp": 1611905248,
  "Slot": 1,
  "DeviceId": "1/1/1",
  "Message": "Ethernet Link Down alarm",
  "Raw": "Jan 10 19:12:39 cns-backhaul-001 rOT1[299]: 70/01/10 19:12:39 critical alarm cleared for nt-a:xfp:1 (service affecting) : Ethernet Link Down alarm"
}
```
### Parameters
| 欄位名    | 型別              | 描述           |
|:--------- |:----------------- |:-------------- |
| Subject   | String            | 事件主題       |
| Timestamp | Integer           | 時間戳         |
| DeviceId  | String            | 異常設備編號   |
| Rack      | Integer or String | 機架編號       |
| Shelf     | Integer           | 架層編號       |
| Slot      | Integer           | 卡板編號       |
| Port      | Integer           | 連接埠號       |
| UserModem | Integer           | 終端用戶設備號 |
| Message   | String            | 事件訊息       |
| Raw       | String            | 原始資料       |
