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.

Gestion des versions de l'API Grid Management dans StorageGRID

PDF

L'API de gestion de grille utilise le versionnage pour permettre des mises à niveau sans interruption de service.

Par exemple, cette URL de requête spécifie la version 4 de l'API.

https://hostname_or_ip_address/api/v4/authorize

La version majeure de l'API est mise à jour lorsque des modifications qui ne sont pas compatibles avec les versions précédentes sont apportées. La version mineure de l'API est mise à jour lorsque des modifications qui sont compatibles avec les versions précédentes sont apportées. Les modifications compatibles incluent l'ajout de nouveaux points de terminaison ou de nouvelles propriétés.

L'exemple suivant illustre comment la version de l'API est incrémentée en fonction du type de modifications apportées.

Type de modification de l'API Ancienne version Nouvelle version

Compatible avec les versions antérieures

2,1

2,2

Non compatible avec les versions antérieures

2,1

3,0

Lorsque vous installez le logiciel StorageGRID pour la première fois, seule la version la plus récente de l'API est activée. Cependant, lorsque vous effectuez une mise à niveau vers une nouvelle version de StorageGRID, vous continuez à avoir accès à l'ancienne version de l'API pendant au moins une version de StorageGRID.

Remarque Vous pouvez configurer les versions prises en charge. Consultez la section config de la documentation de l’API Swagger pour "API de gestion de grille" plus d’informations. Vous devez désactiver la prise en charge de l’ancienne version après avoir mis à jour tous les clients API vers la nouvelle version.

Les requêtes obsolètes sont marquées comme dépréciées de la manière suivante :

  • L'en-tête de réponse est « Deprecated: true »

  • Le corps de la réponse JSON inclut "deprecated": true

  • Un avertissement de dépréciation est ajouté au fichier nms.log. Par exemple :

    Received call to deprecated v2 API at POST "/api/v2/authorize"

Déterminez quelles versions d'API sont prises en charge dans la version actuelle

Utilisez la GET /versions requête API pour obtenir une liste des versions majeures de l'API prises en charge. Cette requête se trouve dans la section config de la documentation de l'API Swagger.

GET https://{{IP-Address}}/api/versions
{
  "responseTime": "2023-06-27T22:13:50.750Z",
  "status": "success",
  "apiVersion": "4.0",
  "data": [
    2,
    3,
    4
  ]
}

Spécifiez une version d'API pour une requête

Vous pouvez spécifier la version de l'API à l'aide d'un paramètre de chemin (/api/v4) ou d'un en-tête (Api-Version: 4). Si vous fournissez les deux valeurs, la valeur de l'en-tête remplace la valeur du chemin.

curl https://[IP-Address]/api/v4/grid/accounts

curl -H "Api-Version: 4" https://[IP-Address]/api/grid/accounts