Compréhension de l’API REST
L’API REST est une interface REST (Representational State Transfer) qui vous permet de vous connecter de manière sécurisée à des équipements Juniper Networks Système d'exploitation Junos (Junos OS), d’exécuter des appels de procédure à distance (rpc commandes), d’utiliser une interface graphique REST EXPLORER pour expérimenter facilement n’importe quelle API REST et utiliser diverses options de format et d’affichage. y compris JavaScript Object Notation (JSON).
L’API REST peut être configurée sur les Junos OS à l’aide de commandes disponibles sous le niveau [edit system services rest] hiérarchique. Une fois configurée, l’API rest REST devient disponible sous la direction du service, une interface rpc REST qui vous permet d’envoyer des commandes à l’équipement depuis un emplacement distant et prend en charge les demandes GET et POST. Avec l’API REST, vous pouvez:
Utilisez les demandes GET pour envoyer des
rpccommandes.Utilisez les requêtes POST pour envoyer des informations via
rpcdes commandes.Récupérer les informations de configuration dans XML, ASCII (texte clair) ou JSON.
Récupérez les données opérationnelles dans XML, ASCII ou JSON.
[edit system services rest] Au niveau de la hiérarchie, vous pouvez configurer et sécuriser le service d’API REST sur un équipement Junos OS, configurer des adresses IP, des numéros de port, des certificats de serveur, des paramètres de contrôle et des options de traçage ; et activer un outil de recherche d’API REST qui vous permet d’essayer les API REST à l’aide d’une interface graphique pratique.
Les options d CLI d’affichage suivantes sont disponibles:
Une
display jsonoption est ajoutée au | (pipe) Commande. Par exemple, la CLI afficheshow interfaces | display jsonles interfaces dans la notation JSON.Une
format="json"option est ajoutée aux commandes du serveur NETCONF pour renvoyer les informations opérationnelles dans la notation JSON.
À partir Junos OS version 17.3R1, OpenConfig prend en charge l’état opérationnel émis directement par les daemons au format JSON, en complément du format XML. Pour configurer le format compact JSON, spécifiez la commande CLI suivante: set system export-format state-data json compact. Cette CLI convertit le format XML en format JSON compact. Autrement, il émette le JSON au format non compact.
La taille de la charge utile de demande entrante de l’API REST ne peut pas dépasser 1174 KB. Solution contourner: blocs les requêtes d’API REST entrantes dans des formats plus modestes.
L’API REST prend en charge l’authentification de base HTTP et toutes les requêtes nécessitent un nom d’utilisateur et un mot de passe codés en base inclus dans l’en-tête Autorisation. La prise en charge HTTP et HTTPS est disponible:
Si vous n’avez pas besoin d’une connexion sécurisée, vous pouvez utiliser HTTP pour échanger des contenus en texte clair.
Nous vous recommandons d’utiliser HTTPS pour échanger du contenu chiffré à l’aide de l’une des suites de chiffrement disponibles. Vous pouvez configurer l’API REST pour demander une authentification du serveur sans authentification client, ou configurer l’authentification mutuelle.
Une fois l’API REST configurée sur l’équipement, de nouveaux points de terminaison REST rpc sont disponibles pour exécuter des commandes simples via des requêtes GET ou POST, rpc ou pour exécuter plusieurs commandes via une seule requête POST. Consultez la soumission d’une demande d’accès à l’API REST et la soumission d’une demande de publication à l’API REST pour plus d’informations.
L’API REST fournit également une interface graphique appelée REST API Explorer, qui vous permet d’apprendre facilement et rapidement comment utiliser l’API REST. Il est désactivé par défaut et peut être activé en set system services rest enable-explorerspécifiant . Pour en savoir plus sur REST API Explorer, consultez l’exemple: Using the REST API Explorer.