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’explorateur de l’API REST

Cet exemple montre comment utiliser éventuellement l’explorateur d’API REST sur un équipement 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’explorateur d’API REST vous permet de tester facilement un ou plusieurs appels RPC. Son interface graphique vous permet de sélectionner la méthode HTTP (GET ou POST), le format de sortie requis (XML, JSON ou texte brut), l’URL RPC, le type de données d’entrée lors de l’utilisation de requêtes POST (XML ou texte brut) et une condition de sortie en cas d’erreur.

Dans Junos, GET et POST peuvent tous deux être utilisés pour exécuter un seul RPC opérationnel (tel que get-software-information). Bien que les deux méthodes puissent récupérer les mêmes informations, l’auto-test de démarrage (POST) est requis lorsque vous devez exécuter plusieurs RPC ou inclure des données XML dans le corps de la requête (à l’aide de l’option -d).

Lorsque vous soumettez la demande, l’explorateur d’API REST affiche l’en-tête de la demande, l’en-tête de la réponse, le corps de la réponse et la demande cURL équivalente, qui sont tous utiles à vos efforts de développement.

Configuration

Pour utiliser l’explorateur d’API REST sur n’importe quel appareil sur lequel l’API REST a été configurée, effectuez les tâches suivantes :

Activation de l’explorateur de l’API REST

Procédure étape par étape

Pour activer l’explorateur de l’API REST :

  1. Configurez l’API REST sur l’appareil.

    Pour plus d’informations et d’exemples, consultez Configuration de l’API REST et Exemple : Configuration de l’API REST .

  2. Vérifiez si l’explorateur de l’API REST est activé.

    Utilisez la show commande pour voir si enable-explorer; apparaît dans la configuration de l’API REST. S’il apparaît, cela signifie que l’explorateur de l’API REST a été activé. S’il n’apparaît pas, vous devez activer l’explorateur de l’API REST.

  3. Activez l’explorateur de l’API REST si nécessaire.

    Utilisez la set commande pour vous assurer que cela enable-explorer; apparaît dans la configuration de l’API REST.

Ouverture de l’explorateur de l’API REST

Procédure étape par étape

Pour ouvrir l’explorateur de l’API REST :

  • Assurez-vous que l’explorateur de l’API REST est activé, ouvrez un navigateur et accédez à l’URL suivante : scheme ://device-name :port (par exemple, https://mydevice:3000).

Exécution d’un seul RPC à l’aide d’une requête HTTP GET

Procédure étape par étape

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

  1. Dans la liste déroulante Méthode HTTP , sélectionnez GET.

  2. Saisissez le point de terminaison de l’URL RPC.

    Par exemple, tapez /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 la réponse :

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

Procédure étape par étape

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

  1. Dans la liste déroulante Méthode HTTP, sélectionnez POST.

  2. Dans la liste déroulante Format de sortie requis, sélectionnez JSON.

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

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

  5. Saisissez la requête au format XML dans la zone de texte Corps de la requête .

    Par exemple:

  6. Cliquez sur Envoyer.

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

  7. Si vous préférez un autre format de sortie, sélectionnez l’un des choix disponibles dans la liste déroulante Format de sortie requis .

    Par exemple, vous pouvez sélectionner Texte brut. Lorsque vous cliquez sur Envoyer, vous verrez du texte brut dans le corps de la réponse :

    De même, si vous sélectionnez XML dans la liste déroulante Format de sortie requis , le corps de la réponse contiendra des informations au format XML :

Exécution de plusieurs RPC

Procédure étape par étape

Pour exécuter plusieurs RPC :

  1. Dans la liste déroulante Méthode HTTP, sélectionnez POST.

    Ceci est toujours nécessaire lors de l’exécution de plusieurs RPC.

  2. Pour définir une sortie conditionnelle en cas d’erreur, cochez la case Quitter en cas d’erreur .

  3. Sélectionnez un format de sortie dans la liste déroulante Format de sortie requis .

    Par exemple, vous pouvez sélectionner JSON.

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

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

  6. Saisissez la requête au format XML dans la zone de texte 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 la 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 cochez la case Quitter en cas d’erreur , un message d’erreur s’affiche dans la sortie si une erreur se produit.

Pour afficher les messages d’erreur :

  1. Dans la liste déroulante Méthode HTTP, sélectionnez POST.

    Ceci est toujours nécessaire lors de l’exécution de plusieurs RPC.

  2. Pour définir une sortie conditionnelle en cas d’erreur, cochez la case Quitter en cas d’erreur .

  3. Sélectionnez un format de sortie dans la liste déroulante Format de sortie requis .

    Par exemple, vous pouvez sélectionner JSON.

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

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

  6. Saisissez la requête au format XML contenant une erreur dans la zone de texte 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 la réponse, et vous pouvez voir un message d’erreur au format XML à la fin du corps de la réponse :

  8. Si vous ne cochez pas la case Quitter en cas d’erreur , un message d’erreur s’affiche dans le corps de la réponse si une erreur se produit.

    L’exécution se poursuivra après le traitement de l’erreur et les résultats seront également inclus dans le corps de la réponse :

Documentation connexe