Warnungsverwaltungs-API-Referenz für lokale Verwaltungskonsolen
Artikel
In diesem Artikel werden die REST-APIs für die Warnungsverwaltung aufgeführt, die für lokale Verwaltungskonsolen von Microsoft Defender für IoT unterstützt werden.
Warnungen (Warnungsinformationen abrufen)
Verwenden Sie diese API, um alle oder gefilterten Warnungen aus einer lokalen Verwaltungskonsole abzurufen.
URI-: /external/v1/alerts oder /external/v2/alerts
UUID (Verwalten von Warnungen basierend auf der UUID)
Verwenden Sie diese API, um bestimmte Aktionen für eine bestimmte Warnung auszuführen, die von Defender für IoT erkannt wurde.
Sie können diese API beispielsweise verwenden, um eine Weiterleitungsregel zu erstellen, die Daten an QRadar weiterleitet. Weitere Informationen finden Sie unter Integrieren von Qradar in Microsoft Defender für IoT.
Definiert den universellen eindeutigen Bezeichner (UniversalLy Unique Identifier, UUID) für die Warnung, die Sie behandeln oder verarbeiten und lernen möchten.
Wenn die Anforderung erfolgreich ist, wird die Inhaltseigenschaft angezeigt. Andernfalls wird die Fehlereigenschaft angezeigt.
Mögliche Inhaltswerte:
Statuscode
Nachricht
Beschreibung
200
Die Warnungsaktualisierungsanforderung wurde erfolgreich abgeschlossen.
Die Updateanforderung wurde erfolgreich abgeschlossen. Keine Kommentare.
200
Warnung wurde bereits behandelt (Handle).
Die Warnung wurde bereits behandelt, wenn eine Handle-Anforderung für die Warnung empfangen wurde. Die Warnung bleibt behandelt.
200
Warnung wurde bereits behandelt und gelernt (handleAndLearn).
Die Warnung wurde bereits behandelt und gelernt, als eine Anforderung zum handleAndLearn empfangen wurde. Die Warnung verbleibt im handledAndLearn Status.
200
Warnung wurde bereits behandelt (behandelt). Behandeln und Lernen (handleAndLearn) wurde für die Warnung ausgeführt.
Die Warnung wurde bereits behandelt, wenn eine Anforderung zum handleAndLearn empfangen wurde. Die Warnung wird handleAndLearn.
200
Warnung wurde bereits behandelt und gelernt (handleAndLearn). Ignorierte Handle-Anforderung.
Die Warnung wurde bereits handleAndLearn, als eine Anforderung zum Behandeln der Warnung empfangen wurde. Die Warnung bleibt handleAndLearn.
500
Ungültige Aktion.
Die gesendete Aktion ist keine gültige Aktion, die für die Warnung ausgeführt werden soll.
500
Unerwarteter Fehler.
Unerwarteter Fehler. Wenden Sie sich an den technischen Support, um das Problem zu beheben.
500
Anforderung konnte nicht ausgeführt werden, weil für diese UUID keine Warnung gefunden wurde.
Die angegebene UUID wurde im System nicht gefunden.
maintenanceWindow (Erstellen von Warnungsausschlüssen)
Verwaltet Wartungsfenster, unter denen Benachrichtigungen nicht gesendet werden. Verwenden Sie diese API, um Stopp- und Startzeiten, Geräte oder Subnetze zu definieren und zu aktualisieren, die beim Auslösen von Warnungen ausgeschlossen werden sollen, oder definieren und aktualisieren Sie Defender für IoT-Engines, die ausgeschlossen werden sollten.
Beispielsweise sollten Sie während eines Wartungsfensters die Benachrichtigungsübermittlung aller Warnungen beenden, mit Ausnahme von Schadsoftwarewarnungen auf kritischen Geräten.
Die Wartungsfenster, die mit der maintenanceWindow-API definiert werden, werden im Fenster "Warnungsausschlüsse" der lokalen Verwaltungskonsole als schreibgeschützte Ausschlussregel angezeigt, die mit der folgenden Syntax benannt ist: Maintenance-{token name}-{ticket ID}.
Wichtig
Diese API wird nur für Wartungszwecke und für einen begrenzten Zeitraum unterstützt und sollte nicht anstelle von Warnungsausschlussregelnverwendet werden. Verwenden Sie diese API nur für einmalige, temporäre Wartungsvorgänge.
Schnur. Definiert die Wartungsticket-ID in den Systemen des Benutzers. Stellen Sie sicher, dass die Ticket-ID nicht mit einem vorhandenen geöffneten Fenster verknüpft ist.
2987345p98234
Erforderlich
ttl-
Positive ganze Zahl. Definiert die TTL (Zeit für das Leben), bei der es sich um die Dauer des Wartungsfensters handelt, in Minuten. Nach Abschluss des definierten Zeitraums wird das Wartungsfenster beendet, und das System verhält sich normal wieder.
180
Erforderlich
Engines
JSON-Array von Zeichenfolgen. Definiert, von welchem Modul Warnungen während des Wartungsfensters unterdrückt werden sollen. Mögliche Werte:
JSON-Array von Zeichenfolgen. Definiert, von welchen Sensoren Warnungen während des Wartungsfensters unterdrückt werden sollen. Sie können diese Sensor-IDs aus den Appliances (Manage OT Sensor Appliances) API abrufen.
1,35,63
Wahlfrei
Subnetze
JSON-Array von Zeichenfolgen. Definiert die Subnetze, um Warnungen während des Wartungsfensters zu unterdrücken. Definieren Sie jedes Subnetz in einer CIDR-Notation.
192.168.0.0/16,138.136.80.0/14,112.138.10.0/8
Wahlfrei
Statuscode
Nachricht
Beschreibung
201 (Erstellt)
-
Die Aktion wurde erfolgreich abgeschlossen.
400 (Ungültige Anfrage)
Keine TicketId
Die API-Anforderung fehlte ein ticketId Wert.
400 (Ungültige Anfrage)
Ungültiger TTL-Parameter
Die API-Anforderung enthielt einen nicht positiven oder nicht numerischen TTL-Wert.
400 (Ungültige Anfrage)
Anforderung konnte nicht analysiert werden.
Problem beim Analysieren des Textkörpers, z. B. falsche Parameter oder ungültige Werte.
400 (Ungültige Anfrage)
Das Wartungsfenster mit denselben Parametern ist bereits vorhanden.
Wird angezeigt, wenn bereits ein vorhandenes Wartungsfenster mit denselben Details vorhanden ist.
404 (Nicht gefunden)
Unbekannte Sensor-ID
Einer der in der Anforderung aufgeführten Sensoren ist nicht vorhanden.
409 (Konflikt)
Die Ticket-ID verfügt bereits über ein geöffnetes Fenster.
Die Ticket-ID ist mit einem anderen geöffneten Wartungsfenster verknüpft.
Definiert die Wartungsticket-ID in den Systemen des Benutzers. Stellen Sie sicher, dass die Ticket-ID mit einem vorhandenen geöffneten Fenster verknüpft ist.
2987345p98234
Erforderlich
Fehlercodes:
Code
Nachricht
Beschreibung
200 (OK)
-
Die Aktion wurde erfolgreich abgeschlossen.
400 (Ungültige Anfrage)
Keine TicketId
Der ticketId Parameter fehlt in der Anforderung.
404 (Nicht gefunden):
Wartungsfenster nicht gefunden.
Die Ticket-ID ist nicht mit einem geöffneten Wartungsfenster verknüpft.
Rufen Sie ein Protokoll aller geöffneten (POST-) abschließen Sie (DELETE) und Aktualisieren (PUT) Aktionen, die mit dieser API zum Behandeln von Wartungsfenstern ausgeführt wurden. T
Filtert die Protokolle aus dem vordefinierten Datum und höher. Das Format ist YYYY-MM-DD.
2022-08-10
Wahlfrei
toDate-
Filtert die Protokolle bis zum vordefinierten Datum. Das Format ist YYYY-MM-DD.
2022-08-10
Wahlfrei
ticketId-
Filtert die Protokolle im Zusammenhang mit einer bestimmten Ticket-ID.
9a5fe99c-d914-4bda-9332-307384fe40bf
Wahlfrei
tokenName-
Filtert die Protokolle im Zusammenhang mit einem bestimmten Tokennamen.
Vierteljährliches Sanity-Fenster
Wahlfrei
Fehlercodes:
Code
Nachricht
Beschreibung
200
OKAY
Die Aktion wurde erfolgreich abgeschlossen.
204:
Kein Inhalt
Es sind keine Daten vorhanden, die angezeigt werden sollen.
400
Ungültige Anforderung
Das Datumsformat ist falsch.
500
Interner Serverfehler
Jeder andere unerwartete Fehler.
Typ: JSON
Array von JSON-Objekten, die Wartungsfenstervorgänge darstellen.
Antwortstruktur:
Name
Art
Nullable / Nicht nullable
Liste der Werte
id
Lange ganze Zahl
Lässt keine Nullwerte zu.
Eine interne ID für das aktuelle Protokoll
dateTime-
Schnur
Lässt keine Nullwerte zu.
Die Zeit, zu der die Aktivität aufgetreten ist, z. B.: 2022-04-23T18:25:43.511Z
ticketId-
Schnur
Lässt keine Nullwerte zu.
Die Wartungsfenster-ID. Beispiel: 9a5fe99c-d914-4bda-9332-307384fe40bf
tokenName-
Schnur
Lässt keine Nullwerte zu.
Der Name des Wartungsfenstertokens. Beispiel: quarterly-sanity-window
Engines
Array von Zeichenfolgen
Nullable
Die Motoren, auf die das Wartungsfenster angewendet wird, wie bei der Erstellung von Wartungsfenstern angegeben: Protocol Violation, Policy Violation, Malware, Anomalyoder Operational
sensorIds
Array der Zeichenfolge
Nullable
Die Sensoren, auf die das Wartungsfenster angewendet wird, wie bei der Erstellung von Wartungsfenstern angegeben.
Subnetze
Array der Zeichenfolge
Nullable
Die Subnetze, auf die das Wartungsfenster angewendet wird, wie bei der Erstellung von Wartungsfenstern angegeben.
ttl-
Numerisch
Nullable
Die Time to Live (TTL) des Wartungsfensters, wie während der Erstellung oder Aktualisierung des Wartungsfensters angegeben.
Ermöglicht es Ihnen, die Dauer des Wartungsfensters zu aktualisieren, nachdem Sie den Wartungsvorgang gestartet haben, indem Sie den parameter ttl ändern. Die neue Dauerdefinition setzt die vorherige außer Kraft.
Diese Methode ist nützlich, wenn Sie eine längere Dauer als die aktuell konfigurierte Dauer festlegen möchten. Wenn Sie beispielsweise ursprünglich 180 Minuten definiert haben, 90 Minuten vergangen sind und Sie weitere 30 Minuten hinzufügen möchten, aktualisieren Sie die ttl auf 120 Minute, um die Daueranzahl zurückzusetzen.