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.
Utiliser des clés d'API pour s'authentifier avec les API HTTP Grafana
Une façon d'accéder aux API Grafana consiste à utiliser une clé d'API, également appelée jeton d'API. Pour créer une clé API, utilisez l'une des procédures suivantes. Une clé API est valide pendant une durée limitée que vous spécifiez lors de sa création, jusqu'à 30 jours.
Rubriques
Important
Les clés d'API sont obsolètes et ont été supprimées dans la version 12 d'Amazon Managed Grafana. Utilisez plutôt des comptes de service. Pour de plus amples informations, veuillez consulter Utilisez des comptes de service pour vous authentifier avec les API HTTP de Grafana.
Lorsque vous créez une clé API, vous spécifiez un rôle pour cette clé. Le rôle détermine le niveau de pouvoir administratif des utilisateurs de la clé.
Les tableaux suivants présentent les autorisations accordées aux rôles d'administrateur, d'éditeur et de spectateur. Le premier tableau présente les autorisations générales de l'organisation. Dans ce tableau, Full 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 Explorer. La colonne Autres autorisations indique si le rôle est autorisé à gérer les utilisateurs, les équipes, les plug-ins et les paramètres organisationnels.
| Role | Tableaux de bord | Playlists | Dossiers | Explorez | Sources de données | Autres autorisations |
|---|---|---|---|---|---|---|
|
Lecteur |
Afficher | Afficher | Non | Non | Non | Non |
|
Editor (Éditeur) |
Complet | Complet | Complet | Oui | Non | Non |
|
Admin |
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 des dossiers. Ils sont différents des rôles d'administrateur, d'éditeur et de spectateur.
| Role | Tableaux de bord | Dossiers | Modifier les autorisations |
|---|---|---|---|
|
Afficher |
Afficher | Afficher | Non |
|
Modifier |
Créer, modifier | Afficher | Non |
|
Admin |
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 la 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 les API Grafana dans l'espace de travail (console)
Note
Dans les espaces de travail Amazon Managed Grafana compatibles avec Grafana version 10 et versions ultérieures, 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.
Les clés d'API sont obsolètes et ont été supprimées dans la version 12 d'Amazon Managed Grafana. Utilisez plutôt des comptes de service. Pour de plus amples informations, veuillez consulter Utilisez des comptes de service pour vous authentifier avec les API HTTP de Grafana.
Pour créer une clé d'API Grafana à utiliser avec les API Grafana dans la console de l'espace de travail
-
Ouvrez la console Amazon Managed Grafana à https://console.aws.amazon.com/grafana/
l'adresse. -
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 Configuration (engrenage), puis choisissez API Keys.
-
Choisissez Nouvelle clé d'API.
-
Entrez un nom unique pour la clé.
-
Dans Rôle, sélectionnez le niveau d'accès auquel la clé doit être accordée. Sélectionnez Admin pour autoriser un utilisateur disposant de cette clé à utiliser les API au niveau administratif le plus large et le plus puissant. Sélectionnez Editor ou Viewer pour limiter le nombre d'utilisateurs de la clé à ces niveaux de puissance. Pour plus d'informations, consultez les tableaux précédents.
-
Pour Time to live, indiquez la durée de validité de la clé. Le maximum est de 30 jours (un mois). Vous saisissez 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, 12h correspond à 12 heures et 1M correspond à 1 mois (30 jours).
Nous vous recommandons vivement de définir la durée de vie de la clé sur une durée plus courte, par exemple quelques heures ou moins. Cela présente 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, consultez Création d'une 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 de clé, du rôle-clé et des secondes de mise en service, consultez le guide de l'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-liveseconds_to_live--workspace-id "workspace_id"
Voici un exemple de réponse de la CLI :
Vous pouvez accéder à votre espace workspace_id de travail en exécutant la commande suivante :
aws grafana list-workspaces
