Skip to main content
Une version plus récente de ce produit est disponible.
La version française est une traduction automatique. La version anglaise prévaut sur la française en cas de divergence.

Utilisez l'API de gestion de grille StorageGRID

PDF

Vous pouvez effectuer des tâches de gestion système à l'aide de l'API REST de Grid Management plutôt qu'en utilisant l'interface utilisateur de Grid Manager. Par exemple, vous pourriez vouloir utiliser l'API pour automatiser des opérations ou pour créer plusieurs entités, telles que des utilisateurs, plus rapidement.

Ressources de haut niveau

L'API de gestion de grille fournit les ressources de premier niveau suivantes :

  • /grid : L’accès est réservé aux utilisateurs de Grid Manager et dépend des autorisations de groupe configurées.

  • /org : L’accès est limité aux utilisateurs appartenant à un groupe LDAP local ou fédéré pour un compte locataire. Pour plus de détails, consultez "Utilisez un compte locataire".

  • /private : L'accès est réservé aux utilisateurs de Grid Manager et dépend des autorisations de groupe configurées. Les API privées sont susceptibles d'être modifiées sans préavis. Les points de terminaison privés de StorageGRID ignorent également la version de l'API de la requête.

Émettre des requêtes API

L'API de gestion de la grille utilise la plateforme API open source Swagger. Swagger offre une interface utilisateur intuitive permettant aux développeurs et aux non-développeurs d'effectuer des opérations en temps réel dans StorageGRID avec l'API.

L'interface utilisateur Swagger fournit des informations et une documentation complètes pour chaque opération API.

Avant de commencer
Avertissement Toute opération API effectuée via la page de documentation API est une opération en direct. Veillez à ne pas créer, modifier ou supprimer par erreur des données de configuration ou autres.
Étapes

  1. Dans l'en-tête de Grid Manager, sélectionnez l'icône d'aide et sélectionnez API documentation.

    Menu d'aide

  2. Pour effectuer une opération avec l'API privée, sélectionnez Accéder à la documentation de l'API privée sur la page de l'API de gestion StorageGRID.

    Les API privées sont susceptibles d'être modifiées sans préavis. Les points de terminaison privés de StorageGRID ignorent également la version de l'API de la requête.

  3. Sélectionnez l'opération souhaitée.

    Lorsque vous développez une opération d'API, vous pouvez voir les actions HTTP disponibles, telles que GET, PUT, UPDATE et DELETE.

  4. Sélectionnez une action HTTP pour afficher les détails de la requête, notamment l'URL du point de terminaison, la liste des paramètres obligatoires ou facultatifs, un exemple du corps de la requête (le cas échéant) et les réponses possibles.

    Exemple de l'interface utilisateur Swagger

  5. Déterminez si la requête nécessite des paramètres supplémentaires, tels qu'un identifiant de groupe ou d'utilisateur. Ensuite, obtenez ces valeurs. Vous devrez peut-être d'abord effectuer une autre requête API pour obtenir les informations dont vous avez besoin.

  6. Déterminez si vous devez modifier le corps de la requête d'exemple. Le cas échéant, vous pouvez sélectionner Modèle pour connaître les exigences relatives à chaque champ.

  7. Sélectionnez Try it out.

  8. Fournissez les paramètres requis ou modifiez le corps de la requête selon les besoins.

  9. Sélectionnez Exécuter.

  10. Examinez le code de réponse pour déterminer si la requête a réussi.