Versionierung der Grid Management API in StorageGRID
Änderungen vorschlagen
PDFs
Die Grid Management API verwendet Versionierung, um unterbrechungsfreie Upgrades zu unterstützen.
Beispielsweise gibt diese Request-URL die Version 4 der API an.
https://hostname_or_ip_address/api/v4/authorize
Die Hauptversion der API wird erhöht, wenn Änderungen vorgenommen werden, die nicht mit älteren Versionen kompatibel sind. Die Nebenversion der API wird erhöht, wenn Änderungen vorgenommen werden, die mit älteren Versionen kompatibel sind. Kompatible Änderungen umfassen das Hinzufügen neuer Endpunkte oder neuer Eigenschaften.
Das folgende Beispiel veranschaulicht, wie die API-Version je nach Art der vorgenommenen Änderungen erhöht wird.
| Art der Änderung an der API | ${post_edited_translations.segment} | Neue Version |
|---|---|---|
${post_edited_translations.segment} |
2,1 |
2,2 |
Nicht kompatibel mit älteren Versionen |
2,1 |
3,0 |
Bei der erstmaligen Installation der StorageGRID Software ist nur die neueste Version der API aktiviert. Wenn jedoch ein Upgrade auf eine neue Funktionsversion von StorageGRID erfolgt, bleibt der Zugriff auf die ältere API-Version für mindestens eine StorageGRID Funktionsversion erhalten.
|
Sie können die unterstützten Versionen konfigurieren. Im Abschnitt config der Swagger API-Dokumentation "Grid Management API" finden sich weitere Informationen. Die Unterstützung für die ältere Version sollte nach der Aktualisierung aller API-Clients auf die neuere Version deaktiviert werden. |
Veraltete Anfragen werden auf folgende Weise als veraltet gekennzeichnet:
-
Der Antwortheader ist „Deprecated: true“.
-
Der JSON-Antworttext enthält "deprecated": true
-
Eine Warnung bezüglich veralteter Technologien wird in nms.log hinzugefügt. Zum Beispiel:
Received call to deprecated v2 API at POST "/api/v2/authorize"
${post_edited_translations.segment}
Die `GET /versions`API-Anfrage gibt eine Liste der unterstützten API-Hauptversionen zurück. Diese Anfrage befindet sich im Abschnitt config der Swagger API-Dokumentation.
GET https://{{IP-Address}}/api/versions
{
"responseTime": "2023-06-27T22:13:50.750Z",
"status": "success",
"apiVersion": "4.0",
"data": [
2,
3,
4
]
}
Eine API-Version für eine Anfrage angeben
Sie können die API-Version mit einem Pfadparameter (/api/v4) oder einem Header (Api-Version: 4) angeben. Wenn beide Werte angegeben werden, überschreibt der Wert im Header den Wert im Pfad.
curl https://[IP-Address]/api/v4/grid/accounts curl -H "Api-Version: 4" https://[IP-Address]/api/grid/accounts