Verstehen der REST-API
Die REST-API ist eine Representational State Transfer (REST)-Schnittstelle, die es Ihnen ermöglicht, eine sichere Verbindung zu Juniper Networks Betriebssystem Junos (Junos OS)-Geräten herzustellen, Remote-Prozeduraufrufe ( Befehle) auszuführen, eine GUI von REST API Explorer zu verwenden, mit der Sie beliebige REST-APIs ganz bequem experimentieren können und eine Vielzahl von Format- und Anzeigeoptionen verwenden, z. B. rpc JavaScript Object Notation (JSON).
Die REST-API kann mithilfe der in der Hierarchieebene verfügbaren Befehle auf Junos OS von Geräten [edit system services rest] konfiguriert werden. Nach der Konfiguration steht die REST-API als Service zur Verfügung, eine REST-basierte Schnittstelle, über die Sie Befehle von einem Remote-Standort an das Gerät senden können, und unterstützt GET- und rest rpc POST-Anfragen. Mit der REST API können Sie:
Verwenden Sie GET-Anforderungen zum Senden von
rpcBefehlen.Senden Sie Informationen über Befehle mithilfe von
rpcPOST-Anforderungen.Rufen Sie Konfigurationsinformationen in XML, ASCII (Nur-Text) oder JSON ab.
Rufen Sie Betriebsdaten in XML, ASCII oder JSON ab.
Auf Hierarchieebene können Sie den REST API-Dienst auf einem Junos OS-Gerät konfigurieren und sichern, IP-Adressen, Portnummern, Serverzertifikate, Kontrollparameter und Trace-Optionen einrichten und ein Tool für den REST API-Explorer aktivieren, mit dem Sie die REST-APIs über eine praktische Benutzeroberfläche testen [edit system services rest] können.
Folgende CLI Anzeigeoptionen sind verfügbar:
Der
display jsonLösung wird eine Option | (Pipe) Befehl. Der Befehl CLI zeigtshow interfaces | display jsondie Schnittstellen beispielsweise in JSON-Notation an.Es
format="json"wird eine Option zu den NETCONF-Serverbefehlen hinzugefügt, um Betriebsinformationen in JSON-Notation zurücksingen zu können.
OpenConfig beginnt Junos OS dem 17.3R1 und unterstützt den Betriebsstatus, der von Daemons direkt im JSON-Format und im XML-Format ausgegeben wird. Geben Sie zum Konfigurieren des json kompakten Formats die folgenden CLI Befehl set system export-format state-data json compact an: Dieser CLI konvertiert das XML-Format in das kompakte JSON-Format. Darüber hinaus gibt er JSON im nicht kompakten Format aus.
Die eingehende Request-Payload-Größe der REST-API darf 1174KB nicht übersteigen.
Umgehung: Verkleinern Sie die eingehenden REST API-Anforderungen.
Die REST-API unterstützt die HTTP-Basic-Authentifizierung, und für alle Anforderungen ist ein im Autorisierungsüberschrift enthaltener Basis64-codierter Benutzername und Kennwort erforderlich. Sowohl HTTP- als auch HTTPS-Unterstützung sind verfügbar:
Wenn Sie keine sichere Verbindung benötigen, können Sie HTTP verwenden, um Inhalte über Klartext zu tauschen.
Wir empfehlen, dass Sie HTTPS verwenden, um verschlüsselte Inhalte über eines der verfügbaren Cipher-Suites austauschen zu können. Sie können die REST-API so konfigurieren, dass Serverauthentifizierung ohne Clientauthentifizierung erforderlich ist, oder Sie können die gegenseitige Authentifizierung konfigurieren.
Sobald die REST API auf dem Gerät konfiguriert ist, stehen neue REST-Endpunkte zur Verfügung, die entweder einzelne Befehle über GET- oder POST-Anforderungen ausführen oder mehrere Befehle über eine einzige rpc rpc POST-Anforderung ausführen können. Weitere Informationen finden Sie unter Senden einer GET-Anfrage an die REST-API und Übermitteln einer POST-Anfrage an die REST-API.
Die REST-API bietet auch eine Gui namens REST API Explorer, mit der Sie einfach und schnell lernen können, wie Sie die REST API verwenden. Sie ist standardmäßig deaktiviert und kann durch Angabe aktiviert set system services rest enable-explorer werden. Weitere Informationen zum REST API Explorer finden Sie unter Beispiel: Verwenden des REST API Explorer.