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 Explorer

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

Anforderungen

  • Ein M Series-Gerät der MX-, T-Serie- oder PTX-Serie, auf dem Junos OS Version 14.2 oder höher ausgeführt wird, ist erforderlich.

Übersicht

Mit dem REST API Explorer können Sie einzelne oder mehrere RPC-Anrufe bequem testen. Die Benutzeroberfläche bietet Ihnen Optionen zur Auswahl der HTTP-Methode (GET oder POST), des erforderlichen Ausgabeformats (XML, JSON oder Nur-Text), der RPC-URL, des Eingabedatentyps bei der Verwendung von POST-Anforderungen (XML oder Nur-Text) sowie einer Bedingung zum Verlassen auf Fehler. Wenn Sie die Anfrage übermitteln, zeigt der REST API Explorer den Request-Header, die Antwort-Überschrift, den Antwort-Text und die entsprechende cURL-Anfrage an, die alle für Ihre Entwicklungsbemühungen nützlich sind.

Konfiguration

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

Aktivieren des REST API-Explorers

Schritt-für-Schritt-Verfahren

So aktivieren Sie den REST API Explorer:

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

    Siehe Konfigurieren der REST-API und Beispiel: Konfigurieren der REST-API für Informationen und Beispiele.

  2. Prüfen Sie, ob der REST API Explorer aktiviert ist.

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

  3. Bei Bedarf den REST API Explorer aktivieren.

    Mit dem set Befehl stellen Sie sicher, dass enable-explorer; dies in der REST API-Konfiguration angezeigt wird.

Öffnen des REST API-Explorers

Schritt-für-Schritt-Verfahren

So öffnen Sie den REST API Explorer:

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

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

Schritt-für-Schritt-Verfahren

So führen Sie einen einzelnen RPC mithilfe von HTTP GET Request aus:

  1. Wählen Sie in der Dropdown-Liste der HTTP-Methode DIE Option GETaus.

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

    Geben Sie beispielsweise /rpc/get-software-information ...

  3. Geben Sie Ihren Benutzernamen und Ihr Passwort ein.

  4. Klicken Sie auf Senden.

    In diesem Beispiel wird XML, das Standardausgabeformat, im Response Body zurückgegeben:

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

Schritt-für-Schritt-Verfahren

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

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

  2. Wählen Sie im Dropdown-Format für das erforderliche Ausgabeformat JSONaus.

  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 Anfrage im XML-Format im Textbereich anforderungen ein.

    Zum Beispiel:

  6. Klicken Sie auf Senden.

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

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

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

    Wenn Sie xml in der Dropdown-Liste für das erforderliche Ausgabeformat auswählen, enthält der Antwort text Informationen im XML-Format:

Ausführen mehrerer RPCs

Schritt-für-Schritt-Verfahren

Ausführung mehrerer RPCs:

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

    Dies ist bei der Ausführung mehrerer RPCs immer erforderlich.

  2. Wenn Sie im Falle eines Fehlers einen bedingten Ausgang festlegen, wählen Sie das Kontrollkästchen "Beenden" aus.

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

    Sie können beispielsweise auf JSONklicken.

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

  5. Geben Sie Ihren Benutzernamen und Ihr Passwort ein.

  6. Geben Sie die Anfrage im XML-Format im Textbereich anforderungen ein.

    Zum Beispiel:

  7. Klicken Sie auf Senden.

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

Fehlermeldungen werden angezeigt

Schritt-für-Schritt-Verfahren

Bei Ausführung mehrerer RPCs kann ein Fehler auftreten. Wenn Sie das Kontrollkästchen "Beenden" im Fehlerfeld auswählen, wird in der Ausgabe eine Fehlermeldung angezeigt, wenn ein Fehler auftritt.

So können Sie Fehlermeldungen anzeigen:

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

    Dies ist bei der Ausführung mehrerer RPCs immer erforderlich.

  2. Wenn Sie im Falle eines Fehlers einen bedingten Ausgang festlegen, wählen Sie das Kontrollkästchen "Beenden" aus.

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

    Sie können beispielsweise auf JSONklicken.

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

  5. Geben Sie Ihren Benutzernamen und Ihr Passwort ein.

  6. Geben Sie die Anfrage im XML-Format mit einem Fehler im Textbereich anforderungen ein.

    Zum Beispiel:

  7. Klicken Sie auf Senden.

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

  8. Wenn Sie das Kontrollkästchen "Beenden" nicht auswählen, wird im Antworttext eine Fehlermeldung angezeigt, wenn ein Fehler auftritt.

    Die Ausführung wird ausgeführt, nachdem der Fehler verarbeitet wurde, und die Ergebnisse werden auch im Antwort-Text berücksichtigt:

Ähnliche Dokumentation