Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

Envoyer une demande de publication à l’API REST

Envoyez des requêtes RPC à l’API REST à l’aide d’une requête POST HTTP. Vous pouvez utiliser la requête POST pour la configuration de l’équipement.

Pour une commande unique, le format général des points de rpc terminaison est:

scheme://device-name:port/rpc/method[@attributes]/params

  • scheme: http ou https

  • method: le nom de n’importe Junos OS rpc commande. Le method nom est identique à celui de l’étiquette. Pour plus d’informations, consultez les opérations de protocole XML, les instructions de traitement et les balises de réponse dans le Guide junos XML Management Protocol Developer Guide et dans l’API XML Junos Operational Developer Reference.

  • params: Valeurs de paramètres en option name[=value] ().

Pour authentifier votre demande, soumettez le nom d’utilisateur et le mot de passe encodés de base inclus dans l’en-tête Autorisation:

Pour spécifier les données en tant que chaîne de requêtes dans l’URI pour les requêtes POST, soumettez les données de requêtes dans le rpc corps du courrier. Dans ce cas, vous pouvez spécifier les appels cURL équivalents comme Content-Type text/plain application/xml indiqués ci-après:

Pour les commandes RPC unique et multiples, les en-têtes HTTP Acceptez peuvent être utilisés pour spécifier le format de retour à l’aide de l’une des valeurs Content-Type suivantes:

  • application/xml (le par défaut)

  • application/json

  • texte/clair

  • texte/html

Par exemple, l’appel cURL suivant spécifie un format de sortie JSON:

Vous pouvez également spécifier le format de sortie à l’aide de format l’attribut facultatif:

Remarque:

Le type de contenu par défaut pour les requêtes POST contenant des arguments dans le corps est l’application/xml. Si vous souhaitez utiliser d’autres contenus, comme une chaîne de requêtes, vous pouvez spécifier un type de texte/simple contenu. Spécifiez format l’attribut dans les commandes de configuration.

Lorsque vous exécutez plusieurs commandes dans une demande unique, le format général du rpc point de terminaison est:

scheme://device-name:port/rpc

Les RPC doivent être fournis sous forme de données XML dans le corps du courrier. Le type de contenu de la réponse est multipart/mixed, avec des limites et un sous-type associés au résultat de chaque exécution RPC. Le format indiqué dans l’en-tête Accepter est utilisé comme format de sortie pour chacun des RPC s’ils manquent un format attribut. Si un en-tête Accepté n’est pas spécifié et qu’aucun attribut n’est spécifié dans un RPC donné, le format de sortie par défaut format est XML. Par exemple, pour envoyer une seule demande HTTP afin d’exécuter les RPC et , envoyer une requête get-software-information get-interface-information POST avec /rpc "Auth: Basic <base64hash>" , "Content-Type: application/xml" Le corps DU COURRIER contient les éléments suivants:

<get-software-information/><get-interface-information/>

Voici un appel cURL utilisant ce corps POST:

Le résultat de la requête, contenant le XML comme défaut, apparaîtrait comme suit:

Vous pouvez également spécifier le format de sortie de chacun des éléments du corps POST. Par exemple, la requête suivante émette JSON pour le RPC et le get-interface-information texte en clair pour le get-software-information RPC:

Lors de l’exécution de plusieurs RPC, en cas d’erreur, le comportement par défaut consiste à ignorer l’erreur et à poursuivre l’exécution. Si vous souhaitez quitter la première erreur, indiquez stop-on-error l’indicateur dans l’URI. Par exemple, la requête suivante configure l’équipement et la termine en cas d’erreur: