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.

Découvrez l'API de gestion des locataires StorageGRID

PDF

Vous pouvez effectuer des tâches de gestion système à l'aide de l'API REST Tenant Management plutôt qu'en utilisant l'interface utilisateur du Tenant 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.

L'API de gestion des locataires :

Pour accéder à la documentation Swagger de l'API de gestion des locataires :

  1. Connectez-vous au Tenant Manager.

  2. En haut du Tenant Manager, sélectionnez l'icône d'aide et sélectionnez API documentation.

Opérations API

L'API de gestion des locataires organise les opérations API disponibles dans les sections suivantes :

  • compte : Opérations sur le compte du locataire actuel, y compris l’obtention d’informations sur l’utilisation du stockage.

  • auth : Opérations permettant d’authentifier la session utilisateur.

    L'API de gestion des locataires prend en charge le schéma d'authentification par jeton Bearer. Pour la connexion d'un locataire, vous fournissez un nom d'utilisateur, un mot de passe et un accountId dans le corps JSON de la demande d'authentification (c'est-à-dire POST /api/v3/authorize). Si l'utilisateur est authentifié avec succès, un jeton de sécurité est renvoyé. Ce jeton doit être fourni dans l'en-tête des demandes d'API ultérieures ("Authorization: Bearer token").

    Pour obtenir des informations sur l'amélioration de la sécurité de l'authentification, consultez "Protégez-vous contre la falsification de requêtes intersites".

    Remarque Si l’authentification unique (SSO) est activée pour le système StorageGRID, vous devez effectuer des étapes différentes pour vous authentifier. Voir le "instructions pour utiliser l'API de gestion de grille".

  • config : opérations relatives à la version du produit et aux versions de l'API de gestion des locataires. Vous pouvez lister la version du produit et les versions majeures de l'API prises en charge par cette version.

  • conteneurs : Opérations sur les compartiments S3.

  • Fonctionnalités désactivées : Opérations permettant d’afficher les fonctionnalités qui pourraient avoir été désactivées.

  • endpoints : opérations de gestion d'un point de terminaison. Les points de terminaison permettent à un compartiment S3 d'utiliser un service externe pour la réplication CloudMirror de StorageGRID, les notifications ou l'intégration de la recherche.

  • grid-federation-connections : Opérations sur les connexions de fédération de grilles et la réplication inter-grilles.

  • Groupes : Opérations permettant de gérer les groupes de locataires locaux et de récupérer les groupes de locataires fédérés à partir d’une source d’identité externe.

  • identity-source : Opérations permettant de configurer une source d’identité externe et de synchroniser manuellement les informations de groupe et d’utilisateur fédérés.

  • ilm : Opérations sur les paramètres de gestion du cycle de vie de l’information (ILM).

  • régions : Opérations permettant de déterminer quelles régions ont été configurées pour le système StorageGRID.

  • s3 : Opérations de gestion des clés d’accès S3 pour les utilisateurs locataires.

  • s3-object-lock : Opérations sur les paramètres globaux de verrouillage d’objets S3, utilisées pour assurer la conformité réglementaire.

  • utilisateurs : Opérations permettant de consulter et de gérer les utilisateurs locataires.

Détails de l'opération

Lorsque vous développez chaque opération API, vous pouvez voir son action HTTP, son URL de point de terminaison, une 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 illustrant l'opération GET groups dans l'API Swagger

Émettre des requêtes API

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. Sélectionnez l'action HTTP pour afficher les détails de la requête.

  2. 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.

  3. 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.

  4. Sélectionnez Try it out.

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

  6. Sélectionnez Exécuter.

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