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.

Utilizzare l'API di gestione della griglia

PDF

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

Risorse di alto livello

L'API di gestione della griglia fornisce le seguenti risorse di primo livello:

  • /grid: L'accesso è limitato agli utenti di Grid Manager e si basa sulle autorizzazioni di gruppo configurate.

  • /org: L'accesso è limitato agli utenti che appartengono a un gruppo LDAP locale o federato per un account tenant. Per maggiori dettagli, vedere "Utilizzare un account tenant" .

  • /private: L'accesso è limitato agli utenti di Grid Manager e si basa sulle autorizzazioni di gruppo configurate. Le API private sono soggette a modifiche senza preavviso. Anche gli endpoint privati ​​StorageGRID ignorano la versione API della richiesta.

Inviare richieste API

L'API Grid Management utilizza la piattaforma API open source Swagger. Swagger fornisce un'interfaccia utente intuitiva che consente agli sviluppatori e ai non sviluppatori di eseguire operazioni in tempo reale in StorageGRID tramite l'API.

L'interfaccia utente di Swagger fornisce dettagli e documentazione completi per ogni operazione API.

Prima di iniziare
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. Dall'intestazione di Grid Manager, seleziona l'icona della guida e seleziona Documentazione API.

    Menu di aiuto

  2. Per eseguire un'operazione con l'API privata, seleziona Vai alla documentazione dell'API privata nella pagina dell'API di gestione StorageGRID .

    Le API private sono soggette a modifiche senza preavviso. Anche gli endpoint privati ​​StorageGRID ignorano la versione API della richiesta.

  3. Selezionare l'operazione desiderata.

    Quando si espande un'operazione API, è possibile visualizzare le azioni HTTP disponibili, come GET, PUT, UPDATE e DELETE.

  4. Selezionare un'azione HTTP per visualizzare i dettagli della richiesta, tra cui 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 da Swagger UI

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

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

  7. Seleziona Provalo.

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

  9. Selezionare Esegui.

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