Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
AUF DIESER SEITE
 

Beispiel: Verwenden des REST API-Explorers

In diesem Beispiel wird veranschaulicht, wie optional der REST API-Explorer auf einem Junos OS-Gerät verwendet wird, auf dem die REST API konfiguriert wurde.

Anforderungen

  • Ein Gerät der M Series, MX-Serie, T-Serie oder PTX-Serie mit Junos OS Version 14.2 oder höher ist erforderlich.

Überblick

Mit dem REST API Explorer können Sie bequem einzelne oder mehrere RPC-Aufrufe testen. Die Benutzeroberfläche bietet Optionen zur Auswahl der HTTP-Methode (GET oder POST), des erforderlichen Ausgabeformats (XML, JSON oder Nur-Text), der RPC-URL, des Eingabedatentyps bei Verwendung von POST-Anforderungen (XML oder Nur-Text) und einer Exit-on-Error-Bedingung.

In Junos können sowohl GET als auch POST verwendet werden, um einen einzelnen operationellen RPC auszuführen (z. B. get-software-information). Obwohl beide Methoden die gleichen Informationen abrufen können, ist POST erforderlich, wenn Sie mehrere RPCs ausführen oder XML-Daten in den Anforderungstext einfügen müssen (mit der Option -d).

Wenn Sie die Anforderung senden, zeigt der REST API-Explorer den Anforderungsheader, den Antwortheader, den Antworttext und die entsprechende cURL-Anforderung an, die alle für Ihre Entwicklungsbemühungen nützlich sind.

Konfiguration

Um den REST API-Explorer auf jedem Gerät zu verwenden, auf dem die REST API konfiguriert wurde, führen Sie die folgenden Aufgaben aus:

Aktivieren des REST API-Explorers

Schritt-für-Schritt-Anleitung

So aktivieren Sie den REST API-Explorer:

  1. Konfigurieren Sie die REST-API auf dem Gerät.

    Weitere Informationen und Beispiele finden Sie unter Konfigurieren der REST-API und Beispiel: Konfigurieren der REST-API .

  2. Überprüfen Sie, ob der REST API-Explorer aktiviert ist.

    Verwenden Sie den show Befehl, um zu sehen, ob enable-explorer; er in der REST API-Konfiguration angezeigt wird. Wenn es angezeigt wird, wurde der REST API-Explorer aktiviert. Wenn es nicht angezeigt wird, müssen Sie den REST API-Explorer aktivieren.

  3. Aktivieren Sie bei Bedarf den REST API-Explorer.

    Verwenden Sie den set Befehl, um sicherzustellen, dass dies enable-explorer; in der REST API-Konfiguration angezeigt wird.

Öffnen des REST API-Explorers

Schritt-für-Schritt-Anleitung

So öffnen Sie den REST API-Explorer:

  • Stellen Sie sicher, dass der REST API-Explorer aktiviert ist, öffnen Sie einen Browser, und wechseln Sie zur folgenden URL: scheme://device-name:port (z. B. https://mydevice:3000).

Ausführen eines einzelnen RPC mit einer HTTP GET-Anforderung

Schritt-für-Schritt-Anleitung

So führen Sie einen einzelnen RPC mit einer HTTP GET-Anforderung aus:

  1. Wählen Sie in der Dropdown-Liste HTTP-Methode die Option GET aus.

  2. Geben Sie den RPC-URL-Endpunkt ein.

    Geben Sie /rpc/get-software-informationz. B. . .

  3. Geben Sie Ihren Benutzernamen und Ihr Passwort ein.

  4. Klicken Sie auf Senden.

    In diesem Beispiel wird das Standardausgabeformat XML im Antworttext zurückgegeben:

Ausführen eines einzelnen RPC mithilfe einer HTTP POST-Anforderung

Schritt-für-Schritt-Anleitung

So führen Sie einen einzelnen RPC mit einer HTTP POST-Anforderung aus:

  1. Wählen Sie in der Dropdown-Liste HTTP-Methode die Option POST aus.

  2. Wählen Sie in der Dropdown-Liste Erforderliches Ausgabeformat die Option JSON aus.

  3. Geben Sie diesen RPC-URL-Endpunkt ein: /rpc/get-software-information.

  4. Geben Sie Ihren Benutzernamen und Ihr Passwort ein.

  5. Geben Sie die XML-formatierte Anforderung in den Textbereich Anforderungstext ein.

    Zum Beispiel:

  6. Klicken Sie auf Senden.

    In diesem Beispiel wird das JSON-Ausgabeformat im Antworttext zurückgegeben:

  7. Wenn Sie ein anderes Ausgabeformat bevorzugen, wählen Sie eine der verfügbaren Optionen in der Dropdown-Liste Erforderliches Ausgabeformat aus.

    Sie können z. B. Nur-Text auswählen. Wenn Sie auf "Senden" klicken, wird im Antworttext Klartext angezeigt:

    Wenn Sie in der Dropdown-Liste Erforderliches Ausgabeformat die Option XML auswählen, enthält der Antworttext XML-formatierte Informationen:

Ausführen mehrerer RPCs

Schritt-für-Schritt-Anleitung

So führen Sie mehrere RPCs aus:

  1. Wählen Sie in der Dropdown-Liste HTTP-Methode die Option POST aus.

    Dies ist immer erforderlich, wenn mehrere RPCs ausgeführt werden.

  2. Um im Fehlerfall ein bedingtes Beenden festzulegen, aktivieren Sie das Kontrollkästchen Bei Fehler beenden .

  3. Wählen Sie in der Dropdown-Liste Erforderliches Ausgabeformat ein Ausgabeformat aus.

    Sie können z. B. JSON auswählen.

  4. Dieser RPC-URL-Endpunkt wird automatisch aufgefüllt: /rpc?exit-on-error=1.

  5. Geben Sie Ihren Benutzernamen und Ihr Passwort ein.

  6. Geben Sie die XML-formatierte Anforderung in den Textbereich Anforderungstext ein.

    Zum Beispiel:

  7. Klicken Sie auf Senden.

    In diesem Beispiel wird das JSON-Ausgabeformat im Antworttext zurückgegeben:

Anzeigen von Fehlermeldungen

Schritt-für-Schritt-Anleitung

Beim Ausführen mehrerer RPCs kann ein Fehler auftreten. Wenn Sie das Kontrollkästchen Bei Fehler beenden aktivieren, wird in der Ausgabe eine Fehlermeldung angezeigt, wenn ein Fehler auftritt.

So zeigen Sie Fehlermeldungen an:

  1. Wählen Sie in der Dropdown-Liste HTTP-Methode die Option POST aus.

    Dies ist immer erforderlich, wenn mehrere RPCs ausgeführt werden.

  2. Um im Fehlerfall ein bedingtes Beenden festzulegen, aktivieren Sie das Kontrollkästchen Bei Fehler beenden .

  3. Wählen Sie in der Dropdown-Liste Erforderliches Ausgabeformat ein Ausgabeformat aus.

    Sie können z. B. JSON auswählen.

  4. Dieser RPC-URL-Endpunkt wird automatisch aufgefüllt: /rpc?exit-on-error=1.

  5. Geben Sie Ihren Benutzernamen und Ihr Passwort ein.

  6. Geben Sie die XML-formatierte Anforderung, die einen Fehler enthält, in den Textbereich Anforderungstext ein.

    Zum Beispiel:

  7. Klicken Sie auf Senden.

    In diesem Beispiel wird das JSON-Ausgabeformat im Antworttext zurückgegeben, und am Ende des Antworttexts wird eine XML-formatierte Fehlermeldung angezeigt:

  8. Wenn Sie das Kontrollkästchen Bei Fehler beenden nicht aktivieren, wird im Antworttext eine Fehlermeldung angezeigt, wenn ein Fehler auftritt.

    Die Ausführung wird fortgesetzt, nachdem der Fehler verarbeitet wurde, und die Ergebnisse werden auch in den Antworttext aufgenommen:

Zugehörige Dokumentation