Skip to main content
Eine neuere Version dieses Produkts ist erhältlich.
Die deutsche Sprachversion wurde als Serviceleistung für Sie durch maschinelle Übersetzung erstellt. Bei eventuellen Unstimmigkeiten hat die englische Sprachversion Vorrang.

Erfahren Sie mehr über die StorageGRID Tenant Management API

Änderungen vorschlagen
PDFs

Sie können Systemmanagement-Aufgaben mithilfe der Tenant-Management-REST-API anstelle der Tenant Manager Benutzeroberfläche ausführen. Beispielsweise möchten Sie die API möglicherweise verwenden, um Vorgänge zu automatisieren oder mehrere Entitäten wie Benutzer schneller zu erstellen.

Die Tenant Management API:

  • Verwendet die Swagger Open-Source-API-Plattform. Swagger bietet eine intuitive Benutzeroberfläche, die Entwicklern und Nicht-Entwicklern die Interaktion mit der API ermöglicht. Die Swagger Benutzeroberfläche bietet vollständige Details und Dokumentationen für jede API-Operation.

  • Verwendet "Versionierung zur Unterstützung unterbrechungsfreier Upgrades".

${post_edited_translations.segment}

  1. Im Tenant Manager anmelden.

  2. Oben im Tenant Manager das Hilfesymbol auswählen und anschließend API documentation auswählen.

API Operationen

${post_edited_translations.segment}

  • Konto: Operationen am aktuellen Mandantenkonto, einschließlich Abruf von Speichernutzungsinformationen.

  • auth: Operationen zur Durchführung der Benutzersitzungsauthentifizierung.

    Die Tenant Management API unterstützt das Bearer Token Authentifizierungsschema. Für eine Tenant-Anmeldung werden Benutzername, Passwort und accountId im JSON-Body der Authentifizierungsanfrage bereitgestellt (das heißt, POST /api/v3/authorize). Wenn der Benutzer erfolgreich authentifiziert wurde, wird ein Sicherheitstoken zurückgegeben. Dieses Token muss im Header nachfolgender API-Anfragen angegeben werden ("Authorization: Bearer token").

    Informationen zur Verbesserung der Sicherheit bei der Authentifizierung finden Sie unter "Schutz vor Cross-Site Request Forgery".

    Hinweis Wenn Single Sign-On (SSO) für das StorageGRID System aktiviert ist, sind andere Schritte zur Authentifizierung erforderlich. Siehe "Anleitung zur Verwendung der Grid Management API".

  • config: Operationen im Zusammenhang mit der Produkteinführung und den Versionen der Tenant Management API. Es ist möglich, die Produktversionsnummer und die von dieser Version unterstützten Hauptversionen der API aufzulisten.

  • Container: Vorgänge an S3-Buckets.

  • deactivated-features: Vorgänge zum Anzeigen von Funktionen, die möglicherweise deaktiviert wurden.

  • Endpunkte: Operationen zur Verwaltung eines Endpunkts. Endpunkte ermöglichen es einem S3-Bucket, einen externen Dienst für StorageGRID CloudMirror Replikation, Benachrichtigungen oder Suchintegration zu verwenden.

  • grid-federation-connections: Vorgänge an grid-federation-connections und gridübergreifender Replikation.

  • Gruppen: Operationen zur Verwaltung lokaler Mandantengruppen und zum Abrufen föderierter Mandantengruppen aus einer externen Identitätsquelle.

  • ${post_edited_translations.segment}

  • ilm: Vorgänge an den Einstellungen für das Information Lifecycle Management (ILM).

  • Regionen: Operationen zur Ermittlung der Regionen, die für das StorageGRID System konfiguriert wurden.

  • s3: Operationen zur Verwaltung von S3-Zugriffsschlüsseln für Mandantenbenutzer.

  • s3-object-lock: Vorgänge an globalen S3 Object Lock-Einstellungen, die zur Unterstützung der Einhaltung gesetzlicher Vorschriften verwendet werden.

  • Benutzer: Vorgänge zum Anzeigen und Verwalten von Mandantenbenutzern.

${post_edited_translations.segment}

Beim Erweitern der einzelnen API-Operationen werden die jeweilige HTTP-Aktion, die Endpunkt-URL, eine Liste aller erforderlichen oder optionalen Parameter, ein Beispiel für den Anfragetext (falls erforderlich) und die möglichen Antworten angezeigt.

Beispiel für die GET groups-Operation in der Swagger APIof_thought

API-Anfragen ausführen

Achtung 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.
Schritte

  1. ${post_edited_translations.segment}

  2. 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.

  3. 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.

  4. Ausprobieren auswählen.

  5. Alle erforderlichen Parameter können angegeben oder der Anfragetext nach Bedarf angepasst werden.

  6. Ausführen auswählen.

  7. Der Antwortcode gibt Aufschluss darüber, ob die Anfrage erfolgreich war.