REST-API (aktiv)

Mit dem aktiven REST-API-Monitor können beliebige REST-APIs überwacht werden, die eine anonyme oder einfache Authentifizierung zulassen. Damit können auch JSON-Antworten mit JSONPATH-Abfragen validiert werden.

So konfigurieren Sie einen aktiven REST-API-Monitor:

Name. Geben Sie dem Monitor einen eindeutigen Namen. Dieser Name wird in der Bibliothek der aktiven Monitore angezeigt.
Description. Geben Sie zusätzliche Informationen zu dem Monitor ein. Diese Beschreibung wird neben dem Namen des Monitors in der Bibliothek der aktiven Monitore angezeigt.
Bei erneutem Suchlauf verwenden. Mit dieser Option versucht WhatsUp Gold, diesen aktiven Monitor zu verwenden, wenn die Erkennung entsprechende neue Bedingungen ermittelt.
Zeitüberschreitung. Geben Sie an, wie lange WhatsUp Gold auf eine Antwort der REST-API wartet, bevor die Verbindung beendet und ein entsprechender Zeitüberschreitungsfehler zurückgegeben wird. Gültig sind Werte zwischen 1 Sekunde und 120 Sekunden.
REST-API
- Benutzerdefinierte Kopfzeilen bearbeiten. Es können bis zu zehn benutzerdefinierte Kopfzeilen, die zum Zugriff auf den REST-API-Endpunkt erforderlich sind, eingegeben werden. Eine Standard-ACCEPT-Kopfzeile wird bereitgestellt und als application/json angegeben.
Note: Zur Überwachung eines REST-API-Endpunkts von Progress Application Server für OpenEdge OEManager muss die ACCEPT-Kopfzeile auf application/vnd.progress+json oder */* gesetzt werden.
- URL der REST-API. Die URL für den REST-API-Endpunkt, der überwacht werden soll.
Note: Als URL für die REST-API werden Referenzvariablen (auch Prozentvariablen genannt) für das System (%System), das Gerät (%Device) und die Anwendung (%Application) unterstützt. Weitere Informationen finden Sie unter Prozentvariablen.
- Methode. Wählen Sie eine unterstützte HTTP-Methode für den REST-API-Endpunkt aus. Derzeit wird nur die GET-Methode unterstützt.
- Zertifikatfehler ignorieren. Aktivieren Sie dieses Kontrollkästchen, wenn WhatsUp Gold alle Zertifikatsfehler ignorieren soll.
- Anonymen Zugriff verwenden. Aktivieren Sie dieses Kontrollkästchen, wenn für den REST-API-Endpunkt keine Authentifizierung erforderlich ist.
Bedingung für „Nicht erreichbar“. Dieser Monitor gilt als nicht erreichbar, wenn einer der aufgeführten HTTP-Antwortcodes ausgegeben wird. Sie können einstellen, welche Antwortcodes die Nichterreichbarkeit des Monitors anzeigen. Sie können ebenfalls eine JSONPATH-Abfrage mit Bedingungen angeben, die die Nichterreichbarkeit des Monitors anzeigen. Der Monitor kann entweder aufgrund einer Bedingung für „Nicht erreichbar“, einer JSONPath-Abfrage oder beides eine Antwort „Nicht erreichbar“ ausgeben.
JSONPath-Abfrage. Konstruieren Sie einen logischen Test zur Bewertung der Bedingungen, die der REST-API-Endpunkt ausgibt:
1. Klicken Sie auf das Symbol „Hinzufügen“, um einen Bedingungstest mit einer JSONPATH-Abfrage einzugeben. In der Standardeinstellung wird „Kein Vergleich eingestellt“ in der Zeile anzeigt.
2. Doppelklicken Sie in das Eingabefeld für die JSONPath-Abfrage und klicken Sie anschließend auf das Lupensymbol. Anschließend werden Sie zur Eingabe von REST-API-Anmeldeinformationen aufgefordert, wenn „Anonymen Zugriff verwenden“ nicht aktiviert ist. Nachdem die Anmeldeinformationen für die REST-API geprüft wurden, wird das Fenster mit dem JSON-Pfadassistenten geöffnet.
3. Wählen Sie den REST-API-Endpunkt aus, der überwacht werden soll.
4. Erstellen Sie einen logischen Test, der eine „Nicht erreichbar“-Bedingung für die Überwachung des REST-API-Endpunkts darstellt. Als Werttypen werden Boolesche Werte, Zahlen, Zeichenketten und Andere unterstützt. Der Datentyp „Andere“ wird verwendet, wenn ein Wert Null ist. Leere Zeichenketten werden unterstützt.
5. Klicken Sie auf Speichern.

Note: Weitere Informationen zu JSONPath und dem JSON-Pfadassistenten finden Sie unter JSONPath-Abfragen und JSON-Pfadassistent.