Gestion des versions de l'API de gestion du grid
Suggérer des modifications
PDF
L'API de gestion du grid utilise la gestion des versions pour prendre en charge les mises à niveau sans interruption.
Par exemple, cette URL de demande spécifie la version 3 de l'API.
https://hostname_or_ip_address/api/v3/authorize
La version majeure de l'API de gestion des locataires est incrémentée lorsque des modifications sont effectuées, qui sont non compatibles avec des versions antérieures. La version mineure de l'API de gestion des locataires est incrémentée lorsque des modifications sont effectuées que sont compatibles avec des versions antérieures. Les modifications compatibles incluent l'ajout de nouveaux noeuds finaux 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 plus anciennes |
2.1 |
2.2 |
Non compatible avec les versions plus anciennes |
2.1 |
3.0 |
Lors de la première installation du logiciel StorageGRID, seule la version la plus récente de l'API de gestion de grille est activée. Cependant, lorsque vous effectuez une mise à niveau vers une nouvelle version de StorageGRID, vous continuez à accéder à l'ancienne version de l'API pour au moins une version de StorageGRID.
|
Vous pouvez utiliser l'API Grid Management pour configurer les versions prises en charge. Pour plus d'informations, reportez-vous à la section « config » de la documentation de l'API swagger. Vous devez désactiver la prise en charge de l'ancienne version après avoir mis à jour tous les clients de l'API Grid Management pour utiliser la version la plus récente. |
Les requêtes obsolètes sont marquées comme obsolètes de l'une des manières suivantes :
-
L'en-tête de réponse est « obsolète : vrai »
-
Le corps de la réponse JSON inclut « obsolète » : vrai
-
Un avertissement obsolète est ajouté à nms.log. Par exemple :
Received call to deprecated v1 API at POST "/api/v1/authorize"
Identification des versions d'API prises en charge dans la version actuelle
Utilisez la requête d'API suivante pour renvoyer une liste des versions principales de l'API prises en charge :
GET https://{{IP-Address}}/api/versions
{
"responseTime": "2019-01-10T20:41:00.845Z",
"status": "success",
"apiVersion": "3.0",
"data": [
2,
3
]
}
Spécifiez une version API pour une demande
Vous pouvez spécifier la version de l'API à l'aide d'un paramètre de chemin d'accès (/api/v3) ou un en-tête (Api-Version: 3). Si vous indiquez les deux valeurs, la valeur de l'en-tête remplace la valeur du chemin d'accès.
curl https://[IP-Address]/api/v3/grid/accounts curl -H "Api-Version: 3" https://[IP-Address]/api/grid/accounts