Accéder aux API ONTAP via un accès proxy
Suggérer des modifications
PDF
Les API de passerelle vous offrent l’avantage d’utiliser les informations d’identification Active IQ Unified Manager pour exécuter les API REST ONTAP et gérer les objets de stockage. Ces API sont disponibles lorsque la fonctionnalité API Gateway est activée à partir de l'interface utilisateur Web d'Unified Manager.
Les API REST d'Unified Manager prennent en charge uniquement un ensemble sélectionné d'actions à effectuer sur les sources de données d'Unified Manager, c'est-à-dire les clusters ONTAP . Vous pouvez bénéficier des autres fonctionnalités via les API ONTAP . Les API de passerelle permettent à Unified Manager d'être une interface de transfert pour le tunneling de toutes les requêtes API à exécuter sur les clusters ONTAP qu'il gère, sans se connecter individuellement à chaque cluster de centre de données. Il fonctionne comme un point de gestion unique pour l’exécution des API sur les clusters ONTAP gérés par votre instance Unified Manager. La fonctionnalité API Gateway permet à Unified Manager d'être un plan de contrôle unique à partir duquel vous pouvez gérer plusieurs clusters ONTAP , sans vous connecter à eux individuellement. Les API de passerelle vous permettent de rester connecté à Unified Manager et de gérer les clusters ONTAP en exécutant des opérations d'API REST ONTAP .
|
Tous les utilisateurs peuvent exécuter une requête en utilisant l’opération GET. Les administrateurs d’applications peuvent exécuter toutes les opérations ONTAP REST. |
La passerelle agit comme un proxy pour tunneliser les requêtes API en conservant l'en-tête et le corps des requêtes dans le même format que dans les API ONTAP . Vous pouvez utiliser vos informations d’identification Unified Manager et exécuter les opérations spécifiques pour accéder et gérer les clusters ONTAP sans transmettre les informations d’identification de cluster individuelles. Il continue de gérer l’authentification du cluster et la gestion du cluster, mais redirige les requêtes API pour qu’elles s’exécutent directement sur le cluster spécifique. La réponse renvoyée par les API est la même que la réponse renvoyée par les API REST ONTAP respectives exécutées directement depuis ONTAP.
| verbe HTTP | Chemin (URL) | Description | ||
|---|---|---|---|---|
|
|
Cette méthode GET récupère la liste de tous les clusters gérés par Unified Manager qui prennent en charge les appels ONTAP REST. Vous pouvez vérifier les détails du cluster et choisir d’exécuter d’autres méthodes en fonction de l’UUID du cluster ou de l’identifiant unique universel (UUID).
|
||
|
|
Il s'agit d'une API proxy à point unique, prenant en charge les opérations POST, DELETE, PATCH et GET pour toutes les API REST ONTAP . Aucune restriction ne s'applique à aucune API tant qu'elle est prise en charge par ONTAP. La fonctionnalité de tunneling ou de proxy ne peut pas être désactivée. Le Le |
Comprendre le tunneling de la passerelle API
Les API de passerelle vous permettent de gérer les objets ONTAP via Unified Manager. Unified Manager gère les clusters et les détails d'authentification et redirige les demandes vers le point de terminaison ONTAP REST. L'API de passerelle transforme l'URL et les liens Hypermedia as the Engine of Application State (HATEOAS) dans l'en-tête et le corps de la réponse avec l'URL de base de la passerelle API. L'API de passerelle agit comme l'URL de base du proxy à laquelle vous ajoutez l'URL ONTAP REST et exécutez le point de terminaison ONTAP REST requis.
|
|
Pour qu'une API ONTAP s'exécute correctement via la passerelle API, l'API doit être prise en charge par la version du cluster ONTAP sur lequel elle est exécutée. L’exécution d’une API qui n’est pas prise en charge sur le cluster ONTAP ne renvoie aucun résultat. |
Dans cet exemple, l'API de passerelle (URL de base du proxy) est : /gateways/{uuid}/
L'API ONTAP utilisée est : /storage/volumes . Vous devez ajouter l’URL REST de l’API ONTAP comme valeur pour le paramètre de chemin.
|
|
Lors de l'ajout du chemin, assurez-vous d'avoir supprimé le “/” symbol at the beginning of the URL. For the API |
L'URL ajoutée est : /gateways/{uuid}/storage/volumes
En exécutant le GET opération, l'URL générée est la suivante : GEThttps://<hostname\>/api/gateways/<cluster_UUID\>/storage/volumes
Le /api la balise de l'URL REST ONTAP est supprimée dans l'URL ajoutée et celle de l'API de passerelle est conservée.
Exemple de commande cURL
curl -X GET "https://<hostname>/api/gateways/1cd8a442-86d1-11e0-ae1c-9876567890123/storage/volumes" -H "accept: application/hal+json" -H "Authorization: Basic <Base64EncodedCredentials>"
L'API renvoie la liste des volumes de stockage dans ce cluster. Le format de réponse est le même que celui que vous recevez lorsque vous exécutez la même API depuis ONTAP. Les codes d'état renvoyés sont les codes d'état ONTAP REST.
Définir la portée de l'API
Toutes les API ont un contexte défini dans le cadre du cluster. Les API qui fonctionnent sur la base de machines virtuelles de stockage ont également le cluster comme portée, c'est-à-dire que les opérations API sont effectuées sur une machine virtuelle de stockage particulière au sein d'un cluster géré. Lorsque vous exécutez le /gateways/{uuid}/{path} API, assurez-vous de saisir l'UUID du cluster (UUID de la source de données Unified Manager) pour le cluster sur lequel vous exécutez l'opération. Pour définir le contexte d'une machine virtuelle de stockage particulière au sein de ce cluster, entrez la clé de la machine virtuelle de stockage comme paramètre X-Dot-SVM-UUID ou le nom de la machine virtuelle de stockage comme paramètre X-Dot-SVM-Name. Le paramètre est ajouté en tant que filtre dans l’en-tête de chaîne et l’opération est exécutée dans le cadre de cette machine virtuelle de stockage à l’intérieur de ce cluster.
Exemple de commande cURL
curl -X GET "https://<hostname>/api/gateways/e4f33f90-f75f-11e8-9ed9-00a098e3215f/storage/volume" -H "accept: application/hal+json" -H "X-Dot-SVM-UUID: d9c33ec0-5b61-11e9-8760-00a098e3215f" -H "Authorization: Basic <Base64EncodedCredentials>"
Pour plus d'informations sur l'utilisation des API REST ONTAP , consultezhttps://docs.netapp.com/us-en/ontap-automation/index.html["Automatisation de l'API REST ONTAP"]