View a markdown version of this page

Usa le chiavi API per autenticarti con le API HTTP di Grafana - Grafana gestito da Amazon

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Usa le chiavi API per autenticarti con le API HTTP di Grafana

Un modo per accedere alle API di Grafana consiste nell'utilizzare una chiave API, chiamata anche token API. Per creare una chiave API, utilizza una delle seguenti procedure. Una chiave API è valida per un periodo di tempo limitato specificato al momento della creazione, fino a 30 giorni.

Importante

Le chiavi API sono obsolete e sono state rimosse nella versione 12 di Amazon Managed Grafana. Utilizza invece gli account di servizio. Per ulteriori informazioni, consulta Usa gli account di servizio per l'autenticazione con le API HTTP Grafana.

Quando crei una chiave API, specifichi un ruolo per la chiave. Il ruolo determina il livello di potere amministrativo di cui dispongono gli utenti della chiave.

Le tabelle seguenti mostrano le autorizzazioni concesse ai ruoli Admin, Editor e Viewer. La prima tabella mostra le autorizzazioni organizzative generali. In questa tabella, Full indica la possibilità di visualizzare, modificare, aggiungere autorizzazioni ed eliminare autorizzazioni. La colonna Esplora indica se il ruolo può utilizzare la vista Esplora. La colonna Altre autorizzazioni mostra se il ruolo dispone delle autorizzazioni per la gestione di utenti, team, plug-in e impostazioni organizzative.

Ruolo Pannelli di controllo Playlist Cartelle Esplora Origini dati Altre autorizzazioni

Visualizzatore

Vista Vista No No No No

Editor

Completa Completa Completa No No

Amministratore

Completa Completa Completa Completa Completa

La tabella seguente mostra le autorizzazioni aggiuntive a livello di dashboard e cartella che è possibile impostare. Sono diversi dai ruoli Admin, Editor e Viewer.

Ruolo Pannelli di controllo Cartelle Modificare le autorizzazioni

Visualizzazione

Vista Vista No

Modificare

Crea, modifica Vista No

Amministratore

Crea, modifica, elimina Crea, modifica, elimina
Nota

Un'autorizzazione con un ambito più ampio con un livello di autorizzazione inferiore non ha effetto se esiste una regola più generale con più autorizzazioni. Ad esempio, se si assegna a un utente il ruolo di Editor organizzativo e quindi si assegnano a quell'utente solo le autorizzazioni di visualizzazione per una dashboard, l'autorizzazione di visualizzazione più restrittiva non ha effetto perché l'utente dispone dell'accesso completo alla modifica grazie al suo ruolo di editor.

Creazione di una chiave API Grafana da utilizzare con le API Grafana nell'area di lavoro (Console)

Nota

Negli spazi di lavoro Amazon Managed Grafana compatibili con Grafana versione 10 e successive, la possibilità di creare chiavi API nell'area di lavoro è stata rimossa. Se il tuo spazio di lavoro è uno spazio di lavoro di Grafana versione 10, puoi creare chiavi API solo tramite la CLI o l'API. AWS

Le chiavi API sono obsolete e sono state rimosse in Amazon Managed Grafana versione 12. Utilizza invece gli account di servizio. Per ulteriori informazioni, consulta Usa gli account di servizio per l'autenticazione con le API HTTP Grafana.

Per creare una chiave API Grafana da utilizzare con le API Grafana nella console dell'area di lavoro
  1. Apri la console Amazon Managed Grafana all'indirizzo. https://console.aws.amazon.com/grafana/

  2. Nell'angolo in alto a sinistra della pagina, scegli l'icona del menu, quindi scegli Tutte le aree di lavoro.

  3. Scegli il nome dello spazio di lavoro Amazon Managed Grafana.

  4. Nella pagina dei dettagli dell'area di lavoro, scegli l'URL visualizzato sotto URL dell'area di lavoro Grafana.

  5. Nel menu laterale della console Grafana, fai una pausa sull'icona di configurazione (ingranaggio), quindi scegli API Keys.

  6. Scegli Nuova chiave API.

  7. Inserisci un nome univoco per la chiave.

  8. Per Ruolo, seleziona il livello di accesso a cui concedere la chiave. Seleziona Amministratore per consentire a un utente con questa chiave di utilizzare le API al livello amministrativo più ampio e potente. Seleziona Editor o Viewer per limitare gli utenti della chiave a quei livelli di potenza. Per ulteriori informazioni, consulta le tabelle precedenti.

  9. Per Time to live, specifica per quanto tempo desideri che la chiave sia valida. Il limite massimo è 30 giorni (un mese). Inserisci un numero e una lettera. Le lettere valide sono s per secondi, m per minuti, h per ore, d per giorni, w per settimane e M per mese. Ad esempio, 12h è 12 ore e 1M è 1 mese (30 giorni).

    Ti consigliamo vivamente di impostare la durata di vita della chiave per un periodo più breve, ad esempio poche ore o meno. Ciò comporta un rischio molto inferiore rispetto all'utilizzo di chiavi API valide per un lungo periodo.

  10. Scegliere Aggiungi.

  11. (Facoltativo) Puoi automatizzare la creazione di chiavi API con l'API Create API Key utilizzando Terraform. Per ulteriori informazioni sull'automazione della creazione di chiavi API utilizzando Terraform, vedi Creazione della chiave API Grafana utilizzando Terraform.

Creazione di una chiave API dello spazio di lavoro Amazon Managed Grafana utilizzando AWS CLI

Per creare una chiave API dello spazio di lavoro Amazon Managed Grafana utilizzando AWS CLI

Nell'esempio seguente, sostituisci key_namekey_role, seconds_to_live e workspace_id con le tue informazioni. Per informazioni sul formato di key-name, key-role e seconds-to-live, consulta la guida API. https://docs.aws.amazon.com/grafana/latest/APIReference/API_CreateWorkspaceApiKey.html

aws grafana create-workspace-api-key --key-name "key_name" --key-role "key_role" --seconds-to-live seconds_to_live --workspace-id "workspace_id"

Di seguito è riportato un esempio di risposta CLI:

esempio di output create-workspace-api-key

Puoi trovare il tuo spazio di lavoro eseguendo il workspace_id seguente comando:

aws grafana list-workspaces