Commencez
Caractéristiques opérationnelles de base
Suggérer des modifications
PDF
Alors QUE REST établit un ensemble commun de technologies et de meilleures pratiques, les détails de chaque API peuvent varier en fonction des choix de conception.
Transaction d'API de demande et de réponse
Chaque appel de l'API REST est exécuté en tant que requête HTTP vers le système ONTAP, qui génère une réponse associée au client. Cette paire de requête/réponse est considérée comme une transaction API. Avant d'utiliser l'API, vous devez connaître les variables d'entrée disponibles pour contrôler une requête et le contenu de la sortie de réponse.
Prise en charge des opérations CRUD
Chaque ressource disponible via l'API REST ONTAP est accessible selon le modèle CRUD :
-
Création
-
Lecture
-
Mise à jour
-
Supprimer
Pour certaines ressources, seul un sous-ensemble des opérations est pris en charge. Pour plus d'informations sur chaque ressource, consultez la page de documentation de l'API ONTAP sur le cluster ONTAP.
Identifiants d'objets
Un identifiant unique est attribué à chaque instance de ressource ou objet lors de sa création. Dans la plupart des cas, l'identificateur est un UUID 128 bits. Ces identifiants sont globalement uniques dans un cluster ONTAP spécifique. Après l'émission d'un appel API qui crée une nouvelle instance d'objet, une URL avec la valeur d'ID associée est renvoyée à l'appelant dans l'en-tête d'emplacement de la réponse HTTP. Vous pouvez extraire l'identificateur et l'utiliser sur les appels suivants lorsque vous faites référence à l'instance de ressource.
|
Le contenu et la structure interne des identificateurs d'objet peuvent changer à tout moment. Vous ne devez utiliser les identificateurs sur les appels API applicables que si nécessaire lorsque vous faites référence aux objets associés. |
Instances et collections d'objets
Selon le chemin de ressource et la méthode HTTP, un appel API peut s'appliquer à une instance d'objet spécifique ou à une collection d'objets.
Opérations synchrones et asynchrones
ONTAP effectue une requête HTTP reçue d'un client de deux manières.
- Traitement synchrone
-
ONTAP exécute la demande immédiatement et répond avec un code d'état HTTP 200 ou 201 s'il réussit.
Chaque demande utilisant les méthodes GET, HEAD et OPTIONS est toujours effectuée de manière synchrone. En outre, les demandes qui utilisent POST, PATCH et DELETE sont conçues pour s'exécuter de manière synchrone si elles devraient se terminer en moins de deux secondes.
- Traitement asynchrone
-
Si une demande asynchrone est valide, ONTAP crée une tâche d'arrière-plan pour traiter la demande et un objet de travail pour ancrer la tâche. L'état HTTP 202 est renvoyé à l'appelant avec l'objet travail. Pour déterminer le succès ou l'échec final, vous devez récupérer l'état du travail.
Les demandes qui utilisent les méthodes POST, PATCH et DELETE sont conçues pour s'exécuter de manière asynchrone si elles devraient prendre plus de deux secondes.
Le return_timeoutLe paramètre de requête est disponible avec des appels d'API asynchrones et peut convertir un appel asynchrone pour terminer de manière synchrone. Reportez-vous à la section "Traitement asynchrone à l'aide de l'objet travail" pour en savoir plus.
Sécurité
La sécurité fournie avec l'API REST repose principalement sur les fonctionnalités de sécurité disponibles avec ONTAP. La sécurité suivante est utilisée par l'API :
- Sécurité de la couche de transport
-
L'ensemble du trafic envoyé sur le réseau entre le client et la LIF ONTAP est généralement chiffré à l'aide de TLS, basé sur les paramètres de configuration du ONTAP.
- Authentification client
-
Les mêmes options d'authentification disponibles avec ONTAP System Manager et le SDK de gestion réseau peuvent également être utilisées avec l'API REST de ONTAP.
- Authentification HTTP
-
Au niveau HTTP, par exemple lors de l'accès direct à l'API REST ONTAP, deux options d'authentification sont disponibles, comme décrit ci-dessous. Dans chaque cas, vous devez créer un en-tête d'autorisation HTTP et l'inclure à chaque demande.
Option Description Authentification de base HTTP
Le nom d'utilisateur et le mot de passe ONTAP sont concaténés avec deux-points. La chaîne est convertie en base64 et incluse dans l'en-tête de la requête.
OAuth 2.0
À partir de ONTAP 9.14, vous pouvez demander un jeton d'accès à un serveur d'autorisation externe et l'inclure comme jeton porteur dans l'en-tête de la demande.
Pour plus d'informations sur OAuth 2.0 et sur sa mise en œuvre dans ONTAP, reportez-vous à la section "Présentation de la mise en œuvre de ONTAP OAuth 2.0". Voir aussi "Préparez l'utilisation des workflows" ci-dessous sur ce site.
- Autorisation ONTAP
-
ONTAP implémente un modèle d'autorisation basé sur des rôles. Le compte que vous utilisez lors de l'accès à l'API REST ou à la page de documentation de l'API ONTAP doit disposer des droits appropriés.