Skip to main content
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 degli inquilini

PDF

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

API di gestione degli inquilini:

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

  • Usi"controllo delle versioni per supportare aggiornamenti non distruttivi" .

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

  1. Sign in a Tenant Manager.

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

operazioni API

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

  • account: Operazioni sull'account del tenant corrente, incluso l'ottenimento di informazioni sull'utilizzo dello spazio di archiviazione.

  • auth: Operazioni per eseguire l'autenticazione della sessione utente.

    L'API di gestione tenant supporta lo schema di autenticazione Bearer Token. Per l'accesso del tenant, è necessario fornire un nome utente, una password e un accountId 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 successive richieste API ("Authorization: Bearer token").

    Per informazioni su come migliorare la sicurezza dell'autenticazione, vedere"Protezione contro la falsificazione delle richieste tra siti" .

    Nota Se per il sistema StorageGRID è abilitato l'accesso Single Sign-On (SSO), è necessario eseguire passaggi diversi per l'autenticazione. Vedi il"istruzioni per l'utilizzo dell'API di gestione della griglia" .

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

  • contenitori: operazioni su bucket S3 o contenitori Swift.

  • deactivated-features: Operazioni per visualizzare le funzionalità 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 StorageGRID CloudMirror.

  • grid-federation-connections: Operazioni sulle connessioni della federazione di griglia e sulla replicazione tra griglie.

  • gruppi: operazioni per gestire gruppi di tenant locali e per recuperare gruppi di tenant federati da una fonte di identità esterna.

  • identity-source: Operazioni per configurare una fonte di identità esterna e per sincronizzare manualmente le informazioni sui gruppi federati e sugli utenti.

  • ilm: Operazioni sulle impostazioni di gestione del ciclo di vita delle informazioni (ILM).

  • 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 tenant.

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

  • utenti: operazioni per visualizzare e gestire gli utenti tenant.

Dettagli dell'operazione

Espandendo ogni operazione API, è possibile visualizzare la relativa azione HTTP, l'URL dell'endpoint, un elenco di eventuali parametri obbligatori o facoltativi, un esempio del corpo della richiesta (quando richiesto) e le possibili risposte.

esempio che mostra l'operazione GET dei gruppi nell'API Swagger

Inviare richieste API

Avvertenza Tutte le operazioni API eseguite tramite la pagina web Documentazione API sono operazioni live. Fare attenzione a non creare, aggiornare o eliminare per errore dati di configurazione o altri dati.
Passi

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

  2. Determina se la richiesta richiede parametri aggiuntivi, come un gruppo o un ID utente. Quindi, ottieni questi valori. Potrebbe essere necessario inviare prima una richiesta API diversa per ottenere le informazioni necessarie.

  3. Determina se è necessario modificare il corpo della richiesta di esempio. In tal caso, puoi selezionare Modello per conoscere i requisiti per ciascun campo.

  4. Seleziona Provalo.

  5. Fornire tutti i parametri richiesti o modificare il corpo della richiesta come richiesto.

  6. Selezionare Esegui.

  7. Esaminare il codice di risposta per determinare se la richiesta è andata a buon fine.