Diese Seite beschreibt die verfügbaren API-Methoden zur Änderung von Prüfobjektgruppen (Monitor Groups).

Beschreibung des MonitorGroup-Objekts

Das MonitorGroup-Objekt wird in den nachfolgend beschriebenen API-Methoden verwendet:

Name Beschreibung
MonitorGroupGuid Die einzigartige Kennung der Prüfobjektgruppe (Monitor Group)
Description Eine Zeichenfolge mit einem beschreibenden Namen
IsAll Zeigt an, ob die Gruppe die Systemgruppe „Alle Prüfobjekte“ ist. True oder False.

Die Gruppe „Alle Prüfobjekte“

Die Gruppe „Alle Prüfobjekte“ (die Beschreibung dieser Gruppe kann anders lauten, abhängig von der Spracheinstellung Deines Kontos) ist eine Systemgruppe, die immer alle Prüfobjekte enthält. Du kannst an dieser Gruppe keine Änderungen vornehmen. Verwenden der GUID dieser Gruppe ist für Vorgänge wichtig, die sich auf eine ganze Gruppe auswirken, beispielsweise alle Prüfobjekte oder Alarme aktivieren/deaktivieren.

Endpunkte zum Management einer Prüfobjektgruppe

Die folgenden API-Endpunkte sind zum Erstellen, Ändern und Entfernen von Prüfobjektgruppen und zum Hinzufügen/Erstellen von Mitgliedern bei dieser Gruppe verfügbar.

Anfragetyp Endpunkt Einsatz
GET /MonitorGroup Ruft alle Prüfobjektgruppen ab
POST /MonitorGroup Erstellt eine neue Prüfobjektgruppe
GET /MonitorGroup/{monitorGroupGuid} Ruft Informationen zu einer Prüfobjektgruppe ab
PUT /MonitorGroup/{monitorGroupGuid} Aktualisiert eine bestehende Prüfobjektgruppe
DELETE /MonitorGroup/{monitorGroupGuid} Löscht eine Prüfobjektgruppe
GET /MonitorGroup/{monitorGroupGuid}/Members Ruft eine Liste aller Prüfobjekte ab, die Teil einer Prüfobjektgruppe sind
POST /MonitorGroup/{monitorGroupGuid}/Members/{monitorGuid} Fügt das angegebene Prüfobjekt zur Prüfobjektgruppe hinzu
DELETE /MonitorGroup/{monitorGroupGuid}/Members/{monitorGuid} Entfernt das angegebene Prüfobjekt aus der Prüfobjektgruppe

Weitere Operationen bei Prüfobjektgruppen

Die folgenden API-Endpunkte sind verfügbar, um Operationen bei allen einer Gruppe zugeordneten Prüfobjekten durchzuführen:

Anfragetyp Endpunkt Einsatz
POST /MonitorGroup/{monitorGroupGuid}/StopAllMonitors Stoppt alle Prüfobjekte der spezifizierten Prüfobjektgruppe
POST /MonitorGroup/{monitorGroupGuid}/StartAllMonitors Startet alle Prüfobjekte der spezifizierten Prüfobjektgruppe
POST /MonitorGroup/{monitorGroupGuid}/StopAllMonitorAlerts Deaktiviert die Warnmeldungen für alle Prüfobjekte der spezifizierten Prüfobjektgruppe
POST /MonitorGroup/{monitorGroupGuid}/StartAllMonitorAlerts Aktiviert die Warnmeldungen für alle Prüfobjekte der spezifizierten Prüfobjektgruppe
POST /MonitorGroup/{monitorGroupGuid}/AddMaintenancePeriodToAllMembers Fügt den angegebenen Wartungszeitraum zu allen Prüfobjekten in der spezifizierten Gruppe hinzu