Mandantenmanagement-API-Versionierung
Änderungen vorschlagen
PDFs
Die Mandanten-Management-API verwendet Versionierung zur Unterstützung unterbrechungsfreier Upgrades.
Diese Anforderungs-URL gibt beispielsweise die Version 4 der API an.
https://hostname_or_ip_address/api/v4/authorize
Die Hauptversion der API wird bei Änderungen, die nicht kompatibel mit älteren Versionen sind, angestoßen. Die Minor-Version der API wird bei Änderungen, die kompatibel mit älteren Versionen gemacht werden, angestoßen. Zu den kompatiblen Änderungen gehört das Hinzufügen neuer Endpunkte oder neuer Eigenschaften.
Das folgende Beispiel zeigt, wie die API-Version basierend auf dem Typ der vorgenommenen Änderungen angestoßen wird.
| Typ der Änderung in API | Alte Version | Neue Version |
|---|---|---|
Kompatibel mit älteren Versionen |
2.1 |
2.2 |
Nicht kompatibel mit älteren Versionen |
2.1 |
3.0 |
Wenn Sie die StorageGRID-Software zum ersten Mal installieren, wird nur die neueste Version der API aktiviert. Wenn Sie jedoch ein Upgrade auf eine neue Funktionsversion von StorageGRID durchführen, haben Sie weiterhin Zugriff auf die ältere API-Version für mindestens eine StorageGRID-Funktionsversion.
|
Sie können die unterstützten Versionen konfigurieren. Siehe den Abschnitt config der Dokumentation zur Swagger API für das "Grid Management API" Finden Sie weitere Informationen. Sie sollten die Unterstützung für die ältere Version deaktivieren, nachdem Sie alle API-Clients aktualisiert haben, um die neuere Version zu verwenden. |
Veraltete Anfragen werden wie folgt als veraltet markiert:
-
Der Antwortkopf ist "Deprecated: True"
-
Der JSON-Antwortkörper enthält „veraltet“: Wahr
-
Eine veraltete Warnung wird nms.log hinzugefügt. Beispiel:
Received call to deprecated v2 API at POST "/api/v2/authorize"
Legen Sie fest, welche API-Versionen in der aktuellen Version unterstützt werden
Verwenden Sie die GET /versions API-Anforderung zur Rückgabe einer Liste der unterstützten API-Hauptversionen. 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
]
}
Geben Sie eine API-Version für eine Anforderung an
Sie können die API-Version mithilfe eines Pfadparameters angeben (/api/v4) Oder eine Kopfzeile (Api-Version: 4). Wenn Sie beide Werte angeben, überschreibt der Kopfzeilenwert den Pfadwert.
curl https://[IP-Address]/api/v4/grid/accounts curl -H "Api-Version: 4" https://[IP-Address]/api/grid/accounts