Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
SUR CETTE PAGE
 

Exemple: Utilisation de l’API REST Explorer

Cet exemple explique comment utiliser en option l’API REST Explorer sur un équipement de Junos OS sur lequel l’API REST a été configurée.

Exigences

  • Un équipement M Series, MX Series, T Series ou PTX Series exécutant Junos OS version 14.2 ou ultérieure est requis.

Aperçu

L’EXPLORER DES API REST vous permet de tester facilement des appels RPC simples ou multiples. Son interface graphique vous permet de sélectionner la méthode HTTP (GET ou POST), le format de sortie requis (XML, JSON ou texte clair), l’URL DU RPC, le type de données d’entrée lors de l’utilisation des requêtes POST (XML ou texte clair) et une condition d’erreur de sortie à l’erreur. Lorsque vous soumettez la demande, l’API Explorer REST affiche l’en-tête de demande, l’en-tête de réponse, le corps de réponse et la demande cURL équivalente, qui sont tous utiles à vos efforts de développement.

Configuration

Pour utiliser l’API REST Explorer sur n’importe quel équipement sur lequel l’API REST a été configurée, exécutez ces tâches:

Activation de l’api REST Explorer

Procédure étape par étape

Pour activer l’API REST Explorer:

  1. Configurez l’API REST sur l’équipement.

    Voir Configurer l’API REST et l’exemple: Configurer l’API REST pour obtenir des informations et des exemples.

  2. Vérifiez si l’API REST Explorer est activée.

    Utilisez la commande show pour savoir si elle enable-explorer; apparaît dans la configuration de l’API REST. S’il apparaît, l’API REST Explorer a été activée. Si elle n’apparaît pas, vous devez activer l’API Explorer REST.

  3. Activez l’API REST Explorer si nécessaire.

    Utilisez la commande set pour vérifier que celle-ci enable-explorer; apparaît dans la configuration de l’API REST.

Ouverture de l’api REST Explorer

Procédure étape par étape

Pour ouvrir l’API REST Explorer:

  • Assurez-vous que l’API REST Explorer est activée, ouvrez un navigateur et allez sur l’URL suivante: scheme://device-name:port (par exemple, https://mydevice:3000).

Exécution d’un RPC unique à l’aide d’une demande DE GET HTTP

Procédure étape par étape

Pour exécuter un seul RPC à l’aide d’une requête HTTP GET:

  1. Dans la liste de pannes de la méthode HTTP, sélectionnez GET.

  2. Entrez le point de terminaison d’URL RPC.

    Par exemple, type /rpc/get-software-information.

  3. Entrez votre nom d’utilisateur et votre mot de passe.

  4. Cliquez sur Envoyer.

    Dans cet exemple, le format de sortie par défaut XML est renvoyé dans le corps de réponse:

Exécution d’un RPC unique à l’aide d’une requête POST HTTP

Procédure étape par étape

Pour exécuter un seul RPC à l’aide d’une requête POST HTTP:

  1. Dans la liste de pannes de la méthode HTTP, sélectionnez POST.

  2. Dans la liste down down du format de sortie Requis , sélectionnez JSON.

  3. Entrez ce point de terminaison URL RPC: /rpc/get-software-information.

  4. Entrez votre nom d’utilisateur et votre mot de passe.

  5. Saisissez la demande au format XML dans la zone du corps de requête.

    Par exemple:

  6. Cliquez sur Envoyer.

    Dans cet exemple, le format de sortie JSON est renvoyé dans le corps de réponse:

  7. Si vous préférez un format de sortie différent, sélectionnez l’un des choix disponibles dans la liste de format de sortie obligatoire.

    Par exemple, vous pouvez sélectionner le texte en clair. Lorsque vous cliquez sur Envoyer, le texte clair est visible dans le corps de réponse:

    De même, si vous sélectionnez XML dans la liste « Down Down » du format de sortie requis, le corps de réponse contient des informations au format XML:

Exécution de plusieurs RPC

Procédure étape par étape

Pour exécuter plusieurs RPC:

  1. Dans la liste de pannes de la méthode HTTP, sélectionnez POST.

    Cette nécessité est toujours requise lors de l’exécution de plusieurs RPC.

  2. Pour définir une sortie conditionnel en cas d’erreur, sélectionnez la case De sortie dans la case de contrôle des erreurs.

  3. Sélectionnez un format de sortie dans la liste de sortie au format requis.

    Par exemple, vous pouvez sélectionner JSON.

  4. Ce point de terminaison d’URL RPC se remplit automatiquement: /rpc?exit-on-error=1

  5. Entrez votre nom d’utilisateur et votre mot de passe.

  6. Saisissez la demande au format XML dans la zone du corps de requête.

    Par exemple:

  7. Cliquez sur Envoyer.

    Dans cet exemple, le format de sortie JSON est renvoyé dans le corps de réponse:

Affichage des messages d’erreur

Procédure étape par étape

Lors de l’exécution de plusieurs RPC, une erreur peut se produire. Si vous sélectionnez La sortie dans la case à cocher, un message d’erreur apparaîtra dans la sortie en cas d’erreur.

Pour afficher les messages d’erreur:

  1. Dans la liste de pannes de la méthode HTTP, sélectionnez POST.

    Cette nécessité est toujours requise lors de l’exécution de plusieurs RPC.

  2. Pour définir une sortie conditionnel en cas d’erreur, sélectionnez la case De sortie dans la case de contrôle des erreurs.

  3. Sélectionnez un format de sortie dans la liste de sortie au format requis.

    Par exemple, vous pouvez sélectionner JSON.

  4. Ce point de terminaison d’URL RPC se remplit automatiquement: /rpc?exit-on-error=1

  5. Entrez votre nom d’utilisateur et votre mot de passe.

  6. Saisissez la demande au format XML contenant une erreur dans la zone de texte du corps De la requête.

    Par exemple:

  7. Cliquez sur Envoyer.

    Dans cet exemple, le format de sortie JSON est renvoyé dans le corps de réponse, et un message d’erreur au format XML est envoyé à la fin du corps de réponse:

  8. Si vous ne sélectionnez pas la case de sortie dans la case à cocher les erreurs, un message d’erreur apparaîtra dans le corps de réponse en cas d’erreur.

    L’exécution se poursuit une fois l’erreur traitée et les résultats seront également inclus dans le corps de réponse:

Documentation connexe