Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
L'un des moyens d'accéder à Grafana APIs consiste à utiliser une clé d'API, également appelée jeton d'API. Pour créer une clé d'API, appliquez l'une des procédures suivantes. Une clé d'API est valide pendant une durée limitée que vous spécifiez lors de sa création, jusqu'à 30 jours.
Rubriques
Note
Dans la version 9 ou ultérieure, il est préférable d'utiliser des comptes de service plutôt que des clés d'API. Les comptes de service remplacent les clés d'API comme principal moyen d'authentifier les applications qui interagissent avec Grafana APIs. Grafana Labs a annoncé que les clés d'API seront supprimées dans une future version.
Lorsque vous créez une clé d'API, vous spécifiez un rôle pour la clé. Le rôle détermine le niveau de pouvoir administratif dont disposent les utilisateurs de la clé.
Les tableaux suivants indiquent les autorisations accordées aux rôles d'administrateur, d'éditeur et de visionneur. Le premier tableau présente les autorisations générales de l'organisation. Dans ce tableau, Complet signifie la possibilité d'afficher, de modifier, d'ajouter des autorisations et de supprimer des autorisations. La colonne Explorer indique si le rôle peut utiliser la vue Explore. La colonne Autres autorisations indique si le rôle dispose d'autorisations pour gérer les utilisateurs, les équipes, les plug-ins et les paramètres organisationnels.
| Rôle | Tableaux de bord | listes de lecture | Dossiers | Explorez | Sources de données | Autres autorisations |
|---|---|---|---|---|---|---|
|
Lecteur |
Vue | Vue | Non | Non | Non | Non |
|
Editor (Éditeur) |
Complet | Complet | Complet | Oui | Non | Non |
|
Administrateur |
Complet | Complet | Complet | Oui | Complet | Complet |
Le tableau suivant indique les autorisations supplémentaires que vous pouvez définir au niveau du tableau de bord et du dossier. Ils sont différents des rôles d'administrateur, d'éditeur et de visionneur.
| Rôle | Tableaux de bord | Dossiers | Modifier les autorisations |
|---|---|---|---|
|
Afficher |
Vue | Vue | Non |
|
Modifier |
Créer, modifier | Vue | Non |
|
Administrateur |
Créer, modifier, supprimer | Créer, modifier, supprimer | Oui |
Note
Une autorisation plus étendue avec un niveau d'autorisation inférieur n'a aucun effet s'il existe une règle plus générale avec plus d'autorisations. Par exemple, si vous attribuez à un utilisateur le rôle d'éditeur organisationnel, puis que vous lui attribuez uniquement les autorisations d'affichage pour un tableau de bord, l'autorisation d'affichage plus restrictive n'a aucun effet car l'utilisateur dispose d'un accès complet aux modifications en raison de son rôle d'éditeur.
Création d'une clé d'API Grafana à utiliser avec Grafana APIs dans l'espace de travail (console)
Note
Dans les espaces de travail Amazon Managed Grafana compatibles avec les versions 10 et supérieures de Grafana, la possibilité de créer des clés d'API dans l'espace de travail a été supprimée. Si votre espace de travail est un espace de travail Grafana version 10, vous ne pouvez créer des clés d'API que via la AWS CLI ou l'API.
La suppression des clés d'API a été annoncée par Grafana Labs pour une future version. Il est recommandé d'utiliser plutôt des comptes de service.
Pour créer une clé d'API Grafana à utiliser avec Grafana dans la console de l'espace de travail APIs
-
Ouvrez la console Amazon Managed Grafana à l'adresse. https://console.aws.amazon.com/grafana/
-
Dans le coin supérieur gauche de la page, cliquez sur l’icône du menu, puis sur Tous les espaces de travail.
-
Choisissez le nom de l'espace de travail Amazon Managed Grafana.
-
Sur la page des détails de l'espace de travail, choisissez l'URL affichée sous URL de l'espace de travail Grafana.
-
Dans le menu latéral de la console Grafana, faites une pause sur l'icône de configuration (engrenage), puis choisissez API Keys.
-
Choisissez Nouvelle clé d'API.
-
Entrez un nom unique pour la clé.
-
Pour Rôle, sélectionnez le niveau d'accès auquel la clé doit être accordée. Sélectionnez Admin pour permettre à un utilisateur possédant cette clé d'utiliser APIs le niveau d'administration le plus large et le plus puissant. Sélectionnez Editor ou Viewer pour limiter les utilisateurs de la clé à ces niveaux de puissance. Pour plus d'informations, consultez les tableaux précédents.
-
Pour Time to live, spécifiez la durée pendant laquelle vous souhaitez que la clé soit valide. La durée maximale est de 30 jours (un mois). Vous entrez un chiffre et une lettre. Les lettres valides sont s pour les secondes, m pour les minutes, h pour les heures, d pour les jours, w pour les semaines et M pour le mois. Par exemple, 12 heures correspondent à 12 heures et 1 million à 1 mois (30 jours).
Nous vous recommandons vivement de définir la durée de vie de la clé pour qu'elle dure moins longtemps, par exemple quelques heures ou moins. Cela crée beaucoup moins de risques que d'avoir des clés d'API valides pendant une longue période.
-
Choisissez Ajouter.
-
(Facultatif) Vous pouvez automatiser la création de clés d'API avec l'API Create API Key à l'aide de Terraform. Pour plus d'informations sur l'automatisation de la création de clés d'API à l'aide de Terraform, voir Création de la clé d'API Grafana
à l'aide de Terraform.
Création d'une clé d'API d'espace de travail Amazon Managed Grafana à l'aide de AWS CLI
Pour créer une clé d'API d'espace de travail Amazon Managed Grafana à l'aide de AWS CLI
Dans l'exemple suivant, remplacez le key_namekey_role, seconds_to_live et workspace_id par vos propres informations. Pour en savoir plus sur le format du nom-clé, du rôle-clé et seconds-to-live consultez https://docs.aws.amazon.com/grafana/latest/APIReference/API_CreateWorkspaceApiKey.html le guide de l'API.
aws grafana create-workspace-api-key --key-name "key_name" --key-role "key_role" --seconds-to-liveseconds_to_live--workspace-id "workspace_id"
Voici un exemple de réponse CLI :
Vous pouvez trouver l'emplacement workspace_id de votre espace de travail en exécutant la commande suivante :
aws grafana list-workspaces