Vous pouvez accéder directement à l'API REST ONTAP via curl ou un langage de programmation. Dans ce cas, l'URL de base est différente de l'URL que vous utilisez lorsque vous accédez à la documentation en ligne de ONTAP ou à System Manager.

Lorsque vous accédez directement à l'API, vous devez ajouter api au domaine ou à l'adresse IP. Par exemple :

https://ontap.demo-example.com/api

Voir "Comment accéder à l'API REST de ONTAP" pour en savoir plus.

Il existe plusieurs paramètres d'entrée couramment utilisés avec la plupart des appels API REST. Ces paramètres ne sont généralement pas décrits dans chaque flux de travail. Vous devez connaître les paramètres. Voir "Variables d'entrée contrôlant une requête API" pour en savoir plus.

Si des paramètres supplémentaires sont nécessaires pour un appel d'API REST spécifique, ils sont inclus dans la section Paramètres d'entrée supplémentaires pour l'exemple de boucle pour chaque flux de travail.

Les valeurs d'ID et les autres variables utilisées avec les exemples de workflow sont opaques et peuvent varier en fonction du cluster ONTAP. Pour améliorer la lisibilité des exemples, les valeurs réelles ne sont pas utilisées. Les variables sont utilisées à la place. Cette approche, basée sur un format et un ensemble cohérents de noms réservés, présente plusieurs avantages, notamment :

Les variables sont formatées pour être utilisées dans un environnement shell Bash. Chaque variable commence par un signe dollar et est placée entre guillemets si nécessaire. Cela les rend reconnaissables à Bash. La casse supérieure est toujours utilisée pour les noms.

Voici quelques mots clés de variable communs. Cette liste n'est pas exhaustive et d'autres variables sont utilisées si nécessaire. Leur signification devrait être évidente sur la base du contexte.

Certains appels de l'API REST, tels que ceux utilisant POST ou PATCH, nécessitent une entrée JSON dans le corps de la requête. Pour plus de clarté, les exemples d'entrée JSON sont présentés séparément des exemples de boucles. Vous pouvez utiliser les exemples d'entrée JSON avec l'une des techniques décrites ci-dessous.

Vous pouvez copier l'exemple d'entrée JSON dans un fichier et l'enregistrer localement. La commande curl fait référence au fichier utilisant le --data paramètre avec la valeur indiquant le nom du fichier avec un @ préfixe.

Vous devez tout d'abord copier et coller l'exemple de boucle dans une coque de terminal. Modifiez ensuite l'exemple pour supprimer complètement le --data à la fin du paramètre et remplacez-le par le --data-raw paramètre. Enfin, copiez et collez dans l'exemple JSON afin qu'il suive la commande curl avec le paramètre mis à jour. Vous devez utiliser des guillemets simples pour envelopper l'exemple d'entrée JSON.

Lors de l'utilisation de l'authentification de base, les informations d'identification de l'utilisateur doivent être incluses avec chaque requête HTTP. Il existe deux options pour envoyer les informations d'identification.

Vous pouvez construire manuellement l'en-tête autorisation et l'inclure aux requêtes HTTP. Cela peut être fait lors de l'utilisation d'une commande curl dans l'interface de ligne de commande ou d'un langage de programmation avec votre code d'automatisation. Les étapes générales comprennent :

Les exemples de boucles de flux de travail incluent cet en-tête avec la variable $BASIC_AUTH que vous devez mettre à jour avant d'utiliser.

Une autre option lors de l'utilisation de curl consiste à supprimer l'en-tête autorisation et à utiliser le paramètre curl user à la place. Par exemple :

--user username:password

Vous devez remplacer les informations d'identification appropriées pour votre environnement. Les informations d'identification ne sont pas codées en base64. Lors de l'exécution de la commande curl avec ce paramètre, la chaîne est codée et l'en-tête autorisation est généré pour vous.

Lorsque vous utilisez OAuth 2.0, vous devez demander un jeton d'accès à un serveur d'autorisation externe et l'inclure à chaque requête HTTP. Les étapes générales de base sont décrites ci-dessous. Voir aussi "Présentation de la mise en œuvre de ONTAP OAuth 2.0" Pour plus d'informations sur OAuth 2.0 et sur son utilisation avec ONTAP.

Avant d'utiliser l'API REST pour accéder à ONTAP, vous devez préparer et configurer l'environnement ONTAP. À un niveau élevé, les étapes comprennent :

Avec ONTAP et le serveur d'autorisation défini et actif, vous pouvez effectuer un appel d'API REST à l'aide d'un jeton OAuth 2.0. La première étape consiste à demander un jeton d'accès au serveur d'autorisation. Cette opération est effectuée en dehors de ONTAP en utilisant l'une des différentes techniques basées sur le serveur. ONTAP n'émet pas de tokens d'accès ni n'effectue de redirection.

Après avoir obtenu un jeton d'accès, vous pouvez construire un en-tête autorisation et l'inclure aux requêtes HTTP. Que vous utilisiez curl ou un langage de programmation pour accéder à l'API REST, vous devez inclure l'en-tête à chaque demande client. Vous pouvez construire l'en-tête comme suit :

Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSld …​