Die REST-API bietet die Möglichkeit, Alarmmeldungen abzurufen und in einem anderen System zu visualisieren oder auszuwerten. In diesem Beispiel zeigen wir, wie Meldungen in Python abgerufen werden können.
Übersicht API-Funktionen
Funktion /anomalies-getalerts
Die Anfrage gibt Alarmmeldungen für eine Überwachung zurück. Der Key für eine Überwachung ist unter Einstellungen / Keys zu finden.
##REST endpoint: `GET /anomalies-getalerts`
## Query Parameters
- **limit** (int, default `50`, max `10000`): maximum number of alerts returned
- **hours** (int, optional): limit alerts to the last N hours
- **activeonly** (bool string, default `false`): `"true"` returns only active alerts
- **start** (datetime string, optional): start timestamp (parsed, timezone info dropped)
- **end** (datetime string, optional): end timestamp (parsed, timezone info dropped)
- **nice** (bool string, default `false`): `"true"` enables human-friendly formatting
##Example for API Call
r = get("http://localhost/anomalies-getalerts?_key=1234&nice=true")
print(r.json())
Antwort der Anfrage, wenn Parameter "nice=true":
{'success': True,
'alerts':
[
{'name': 'Tabelle_Daten',
'columns': [{'id': 'c74b45c94d1_1', 'name': 'Temp. 1 Mischk. [°C] (Integral)'},….]
'metadata': [{'id': 'mdedefaf4c5', 'name': '__IMPORT_ID', 'type': 'int'},…],
'message':"Bitte reinigen",
'pipeline':"Überwachung Mischzeiten",
'start': '2024-10-16T06:44:08.320901',
'end': '2024-10-16T06:44:08.320901',
'id':65,
'active':False,
'user':'Admin',
'autoClose':True,
'comment'
}
]
