Verwenden Sie die StorageGRID Grid Management API
Änderungen vorschlagen
PDFs
Systemmanagement-Aufgaben können mithilfe der Grid Management REST API anstelle der Grid Manager Benutzeroberfläche durchgeführt werden. Beispielsweise kann die API verwendet werden, um Vorgänge zu automatisieren oder mehrere Entitäten, wie Benutzer, schneller zu erstellen.
Ressourcen der obersten Ebene
Die Grid Management API stellt die folgenden Ressourcen der obersten Ebene bereit:
-
/grid: Der Zugriff ist auf Grid Manager Benutzer beschränkt und basiert auf den konfigurierten Gruppenberechtigungen. -
/org: Der Zugriff ist auf Benutzer beschränkt, die einer lokalen oder föderierten LDAP-Gruppe für ein Mandantenkonto angehören. Weitere Informationen finden sich unter "Ein Mandantenkonto verwenden". -
/private: Der Zugriff ist auf Grid Manager-Benutzer beschränkt und basiert auf den konfigurierten Gruppenberechtigungen. Die privaten APIs können sich ohne Vorankündigung ändern. StorageGRID private Endpunkte ignorieren außerdem die API-Version der Anfrage.
API-Anfragen ausführen
Die Grid Management API nutzt die Open-Source-API-Plattform Swagger. Swagger bietet eine intuitive Benutzeroberfläche, die es Entwicklern und Nicht-Entwicklern ermöglicht, Echtzeit-Operationen in StorageGRID mithilfe der API durchzuführen.
Die Swagger-Benutzeroberfläche bietet vollständige Details und Dokumentation für jede API-Operation.
-
Sie sind mit einem "unterstützte Webbrowser" beim Grid Manager angemeldet.
-
Du hast "spezifische Zugriffsberechtigungen".
|
Alle API-Operationen, die Sie über die API-Dokumentationswebseite durchführen, sind Live-Operationen. Es ist darauf zu achten, dass Konfigurationsdaten oder andere Daten nicht versehentlich erstellt, aktualisiert oder gelöscht werden. |
-
Im Grid Manager Header das Hilfesymbol auswählen und anschließend API-Dokumentation wählen.
-
Um eine Operation mit der privaten API durchzuführen, auf der StorageGRID Management API-Seite Zur Dokumentation der privaten API gehen auswählen.
Die privaten APIs können sich ohne Vorankündigung ändern. Private Endpunkte von StorageGRID ignorieren außerdem die API-Version der Anfrage.
-
Den gewünschten Vorgang auswählen.
Wenn eine API-Operation erweitert wird, sind die verfügbaren HTTP-Aktionen wie GET, PUT, UPDATE und DELETE sichtbar.
-
Eine HTTP-Aktion kann ausgewählt werden, um die Anfragedetails einschließlich der Endpunkt-URL, einer Liste aller erforderlichen oder optionalen Parameter, eines Beispiels für den Anfragetext (falls erforderlich) und der möglichen Antworten anzuzeigen.
-
Es ist zu ermitteln, ob die Anforderung zusätzliche Parameter wie eine Gruppen- oder Benutzer-ID erfordert. Anschließend sind diese Werte abzurufen. Möglicherweise muss zuerst eine andere API-Anforderung gesendet werden, um die benötigten Informationen zu erhalten.
-
Es kann geprüft werden, ob der Beispiel-Anfragetext angepasst werden muss. Ist dies der Fall, steht Model zur Verfügung, um die Anforderungen für jedes Feld anzuzeigen.
-
Ausprobieren auswählen.
-
Alle erforderlichen Parameter können angegeben oder der Anfragetext nach Bedarf angepasst werden.
-
Ausführen auswählen.
-
Der Antwortcode gibt Aufschluss darüber, ob die Anfrage erfolgreich war.