Verwenden Sie API-Schlüssel, um sich mit Grafana-HTTP-APIs zu authentifizieren - Amazon Managed Grafana
Erstellen eines Workspace-API-Schlüssels (Konsole)Einen Workspace-API-Schlüssel erstellen ()AWS CLI

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Verwenden Sie API-Schlüssel, um sich mit Grafana-HTTP-APIs zu authentifizieren

Eine Möglichkeit, auf Grafana-APIs zuzugreifen, ist die Verwendung eines API-Schlüssels, der auch als API-Token bezeichnet wird. Verwenden Sie eines der folgenden Verfahren, um einen API-Schlüssel zu erstellen. Ein API-Schlüssel ist für eine begrenzte Zeit gültig, die Sie bei der Erstellung angeben, bis zu 30 Tage.

Anmerkung

In Version 9 oder neuer wird die Verwendung von Dienstkonten anstelle von API-Schlüsseln bevorzugt. Dienstkonten ersetzen API-Schlüssel als primäre Methode zur Authentifizierung von Anwendungen, die mit Grafana-APIs interagieren. Grafana Labs hat angekündigt, dass API-Schlüssel in einer future Version entfernt werden.

Wenn Sie einen API-Schlüssel erstellen, geben Sie eine Rolle für den Schlüssel an. Die Rolle bestimmt den Grad der administrativen Befugnisse, über die Benutzer des Schlüssels verfügen.

In den folgenden Tabellen sind die Berechtigungen aufgeführt, die den Rollen Admin, Editor und Viewer gewährt wurden. Die erste Tabelle zeigt allgemeine organisatorische Berechtigungen. In dieser Tabelle bedeutet Vollständig die Fähigkeit, Berechtigungen einzusehen, zu bearbeiten, hinzuzufügen und zu löschen. In der Spalte Erkunden wird angezeigt, ob die Rolle die Explore-Ansicht verwenden kann. In der Spalte Andere Berechtigungen wird angezeigt, ob die Rolle über Berechtigungen zur Verwaltung von Benutzern, Teams, Plug-ins und Organisationseinstellungen verfügt.

Rolle Dashboards Playlisten Ordner Erkunden Datenquellen Andere Genehmigungen

Betrachter

 Anzeigen Anzeigen Nein Nein Nein Nein

Editor (Editor)

 Voll Voll Voll Ja Nein Nein

Admin.

 Voll Voll Voll Ja Voll Voll

Die folgende Tabelle zeigt die zusätzlichen Berechtigungen auf Dashboard- und Ordnerebene, die Sie festlegen können. Diese unterscheiden sich von den Rollen Admin, Editor und Viewer.

Rolle Dashboards Ordner Berechtigungen ändern

Anzeigen

 Anzeigen Anzeigen Nein

Edit (Bearbeiten)

 Erstellen, bearbeiten Anzeigen Nein

Admin.

 Erstellen, bearbeiten, löschen Erstellen, bearbeiten, löschen Ja
Anmerkung

Eine umfassendere Berechtigung mit einer niedrigeren Berechtigungsstufe hat keine Wirkung, wenn eine allgemeinere Regel mit mehr Rechten existiert. Wenn Sie einem Benutzer beispielsweise die Rolle des organisatorischen Redakteurs zuweisen und diesem Benutzer dann nur die Anzeigeberechtigungen für ein Dashboard zuweisen, hat die restriktivere Anzeigeberechtigung keine Auswirkung, da der Benutzer aufgrund seiner Editor-Rolle vollen Bearbeitungszugriff hat.

Erstellen eines Grafana-API-Schlüssels zur Verwendung mit Grafana-APIs im Workspace (Konsole)

Anmerkung

In Amazon Managed Grafana-Workspaces, die mit Grafana-Version 10 und höher kompatibel sind, wurde die Möglichkeit, API-Schlüssel im Workspace zu erstellen, entfernt. Wenn es sich bei Ihrem Workspace um einen Grafana-Workspace der Version 10 handelt, können Sie API-Schlüssel nur über die AWS CLI oder API erstellen.

Die Entfernung von API-Schlüsseln wurde von Grafana Labs für eine future Version angekündigt. Es wird empfohlen, stattdessen Dienstkonten zu verwenden.

Um einen Grafana-API-Schlüssel zur Verwendung mit Grafana-APIs in der Workspace-Konsole zu erstellen

  1. Öffnen Sie die Amazon Managed Grafana-Konsole unter https://console.aws.amazon.com/grafana/.

  2. Wählen Sie in der oberen linken Ecke der Seite das Menüsymbol und dann Alle Workspaces.

  3. Wählen Sie den Namen des Amazon Managed Grafana-Arbeitsbereichs.

  4. Wählen Sie auf der Seite mit den Workspace-Details die URL aus, die unter Grafana-Workspace-URL angezeigt wird.

  5. Machen Sie im Seitenmenü der Grafana-Konsole eine Pause auf dem Konfigurationssymbol (Zahnrad) und wählen Sie dann API-Schlüssel.

  6. Wählen Sie Neuer API-Schlüssel.

  7. Geben Sie einen eindeutigen Namen für den Schlüssel ein.

  8. Wählen Sie unter Rolle die Zugriffsebene aus, der der Schlüssel gewährt werden soll. Wählen Sie Admin aus, um einem Benutzer mit diesem Schlüssel die Nutzung von APIs auf der breitesten und leistungsfähigsten Administrationsebene zu ermöglichen. Wählen Sie Editor oder Viewer, um die Benutzer des Schlüssels auf diese Leistungsebenen zu beschränken. Weitere Informationen finden Sie in den vorherigen Tabellen.

  9. Geben Sie unter Time to Live an, wie lange der Schlüssel gültig sein soll. Das Maximum beträgt 30 Tage (ein Monat). Sie geben eine Zahl und einen Buchstaben ein. Die gültigen Buchstaben sind s für Sekunden, m für Minuten, h für Stunden, d für Tage, w für Wochen und M für Monat. Beispielsweise steht 12h für 12 Stunden und 1M für 1 Monat (30 Tage).

    Es wird dringend empfohlen, die Gültigkeitsdauer des Schlüssels auf einen kürzeren Zeitraum einzustellen, z. B. auf einige Stunden oder weniger. Dies birgt ein viel geringeres Risiko als API-Schlüssel, die für eine lange Zeit gültig sind.

  10. Wählen Sie Hinzufügen aus.

  11. (Optional) Sie können die Erstellung von API-Schlüsseln mit der Create API Key API mithilfe von Terraform automatisieren. Weitere Informationen zur Automatisierung der API-Schlüsselerstellung mit Terraform finden Sie unter Grafana-API-Schlüssel mit Terraform erstellen.

Erstellen eines Amazon Managed Grafana-Workspace-API-Schlüssels mit AWS CLI

So erstellen Sie einen Amazon Managed Grafana-Workspace-API-Schlüssel mit AWS CLI

Ersetzen Sie im folgenden Beispiel key_name, key_role, seconds_to_live und workspace_id durch Ihre eigenen Informationen. Informationen zum Format von Schlüsselname, Schlüsselrolle und finden Sie im API-Leitfaden. seconds-to-live 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"

Im Folgenden finden Sie ein Beispiel für eine CLI-Antwort:

create-workspace-api-key Beispiel für eine Ausgabe

Sie können die workspace_id Ihres Workspace ermitteln, indem Sie den folgenden Befehl ausführen:

aws grafana list-workspaces