Skip to main content
È disponibile una versione più recente di questo prodotto.
La versione in lingua italiana fornita proviene da una traduzione automatica. Per eventuali incoerenze, fare riferimento alla versione in lingua inglese.

Comprendere l'API di gestione dei tenant

Collaboratori
PDF

È possibile eseguire attività di gestione del sistema utilizzando l'API REST di Tenant Management invece dell'interfaccia utente di Tenant Manager. Ad esempio, è possibile utilizzare l'API per automatizzare le operazioni o creare più entità, ad esempio gli utenti, più rapidamente.

L'API di gestione dei tenant:

  • Utilizza la piattaforma API open source Swagger. Swagger offre un'interfaccia utente intuitiva che consente a sviluppatori e non sviluppatori di interagire con l'API. L'interfaccia utente di Swagger fornisce dettagli completi e documentazione per ogni operazione API.

  • Utilizzi "versione per supportare aggiornamenti senza interruzioni".

Per accedere alla documentazione Swagger per l'API di gestione tenant:

  1. Accedi al tenant manager.

  2. Nella parte superiore di Tenant Manager, selezionare l'icona della guida e selezionare documentazione API.

Operazioni API

L'API di gestione tenant organizza le operazioni API disponibili nelle seguenti sezioni:

  • Account: Operazioni sull'account tenant corrente, incluso il recupero delle informazioni sull'utilizzo dello storage.

  • Auth: Operazioni per l'autenticazione della sessione utente.

    L'API di gestione tenant supporta lo schema di autenticazione del token del bearer. Per l'accesso del tenant, immettere un nome utente, una password e un ID account nel corpo JSON della richiesta di autenticazione (ovvero POST /api/v3/authorize). Se l'utente viene autenticato correttamente, viene restituito un token di sicurezza. Questo token deve essere fornito nell'intestazione delle richieste API successive ("autorizzazione: Token portante").

    Per informazioni su come migliorare la protezione dell'autenticazione, vedere "Protezione contro la falsificazione di richieste cross-site".

    Nota Se per il sistema StorageGRID è attivato il Single Sign-on (SSO), è necessario eseguire diversi passaggi per l'autenticazione. Vedere "Istruzioni per l'utilizzo dell'API Grid Management".

  • Config: Operazioni relative alla release del prodotto e alle versioni dell'API di gestione tenant. È possibile elencare la versione di release del prodotto e le principali versioni dell'API supportate da tale release.

  • Container: Operazioni su bucket S3 o container Swift.

  • Disattivato-funzioni: Operazioni per visualizzare le funzioni che potrebbero essere state disattivate.

  • Endpoint: Operazioni per gestire un endpoint. Gli endpoint consentono a un bucket S3 di utilizzare un servizio esterno per la replica, le notifiche o l'integrazione della ricerca di StorageGRID CloudMirror.

  • Grid-Federation-Connections: Operazioni su connessioni di federazione di grid e replica cross-grid.

  • Groups: Operazioni per gestire gruppi tenant locali e recuperare gruppi tenant federati da un'origine di identità esterna.

  • Identity-source: Operazioni per configurare un'origine di identità esterna e sincronizzare manualmente le informazioni di utenti e gruppi federati.

  • Regioni: Operazioni per determinare quali regioni sono state configurate per il sistema StorageGRID.

  • s3: Operazioni per gestire le chiavi di accesso S3 per gli utenti del tenant.

  • s3-Object-lock: Operazioni sulle impostazioni globali S3 Object Lock, utilizzate per supportare la conformità alle normative.

  • Utenti: Operazioni per visualizzare e gestire gli utenti del tenant.

Dettagli dell'operazione

Quando si espandono le operazioni API, è possibile visualizzare l'azione HTTP, l'URL dell'endpoint, un elenco di eventuali parametri obbligatori o facoltativi, un esempio del corpo della richiesta (se necessario) e le possibili risposte.

Esempio che mostra l'operazione GET groups nell'API Swagger

Emettere richieste API

Avvertenza Tutte le operazioni API eseguite utilizzando la pagina web API Docs sono operazioni live. Fare attenzione a non creare, aggiornare o eliminare per errore i dati di configurazione o altri dati.
Fasi

  1. Selezionare l'azione HTTP per visualizzare i dettagli della richiesta.

  2. Determinare se la richiesta richiede parametri aggiuntivi, ad esempio un ID utente o un gruppo. Quindi, ottenere questi valori. Potrebbe essere necessario emettere prima una richiesta API diversa per ottenere le informazioni necessarie.

  3. Determinare se è necessario modificare il corpo della richiesta di esempio. In tal caso, è possibile selezionare modello per conoscere i requisiti di ciascun campo.

  4. Selezionare Provalo.

  5. Fornire i parametri richiesti o modificare il corpo della richiesta secondo necessità.

  6. Selezionare Esegui.

  7. Esaminare il codice di risposta per determinare se la richiesta ha avuto esito positivo.