As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
Use chaves de API para se autenticar com as APIs HTTP do Grafana
Uma forma de acessar as APIs do Grafana é usar uma chave de API, que também é chamada de token de API. Para criar uma chave de API, use um dos procedimentos a seguir. Uma chave de API é válida por um tempo limitado que você especifica ao criá-la, até 30 dias.
Tópicos
nota
Na versão 9 ou mais recente, é preferível usar contas de serviço em vez de chaves de API. As contas de serviço estão substituindo as chaves de API como a principal forma de autenticar aplicações que interagem com as APIs do Grafana. A Grafana Labs anunciou que as chaves de API serão removidas em uma versão futura.
Ao criar uma chave de API, você especifica um perfil para a chave. O perfil determina o nível de poder administrativo que os usuários da chave têm.
As tabelas a seguir mostram as permissões concedidas aos perfis de Administrador, Editor e Visualizador. A primeira tabela mostra as permissões organizacionais gerais. Nessa tabela, Completo significa a capacidade de visualizar, editar, adicionar e excluir permissões. A coluna Explore mostra se o perfil pode usar a visualização Explore. A coluna Outras permissões mostra se o perfil tem permissões para gerenciar usuários, equipes, plug-ins e configurações organizacionais.
| Função | Painéis | Listas de reprodução | Pastas | Explore | Fontes de dados | Outras permissões |
|---|---|---|---|---|---|---|
|
Visualizador |
Visão | Visão | Não | Não | Não | Não |
|
Editor |
Full | Full | Full | Sim | Não | Não |
|
Admin |
Full | Full | Full | Sim | Full | Full |
A tabela a seguir mostra as permissões adicionais no nível de dashboard e pasta que você pode definir. Elas são diferentes dos perfis de Administrador, Editor e Visualizador.
| Função | Painéis | Pastas | Alterar permissões. |
|---|---|---|---|
|
Visão |
Visão | Visão | Não |
|
Edite |
Criar, editar | Visão | Não |
|
Admin |
Criar, editar, excluir | Criar, editar, excluir | Sim |
nota
Uma permissão de maior escopo com um nível de permissão mais baixo não terá efeito se existir uma regra mais geral com mais permissões. Por exemplo, se você atribuir a um usuário o perfil organizacional de Editor e, em seguida, atribuir a esse usuário somente as permissões de Visualizar para um dashboard, a permissão de Visualizar mais restritiva não terá efeito porque o usuário tem acesso total para Editar devido ao perfil de Editor.
Criar uma chave de API do Grafana para usar com as APIs do Grafana no espaço de trabalho (console)
nota
Nos espaços de trabalho do Amazon Managed Grafana compatíveis com o Grafana versão 10 e superior, a capacidade de criar chaves de API no espaço de trabalho foi removida. Se seu espaço de trabalho for um espaço de trabalho do Grafana versão 10, você só poderá criar chaves de API por meio da AWS CLI ou da API.
A remoção das chaves de API foi anunciada pela Grafana Labs para uma versão futura. É recomendável que você use contas de serviço em vez disso.
Para criar uma chave de API do Grafana para usar com as APIs do Grafana no console do espaço de trabalho
-
Abra o console do Amazon Managed Grafana em https://console.aws.amazon.com/grafana/
. -
No canto superior esquerdo da página, selecione o ícone do menu e escolha Todos os workspaces.
-
Escolha o nome do espaço de trabalho do Amazon Managed Grafana.
-
Na página de detalhes do espaço de trabalho, escolha o URL exibido em URL do espaço de trabalho do Grafana.
-
No menu lateral do console do Grafana, pause no ícone de Configuração (engrenagem) e escolha Chaves de API.
-
Escolha Nova chave de API.
-
Insira um nome exclusivo para a chave.
-
Em Perfil, selecione o nível de acesso ao qual a chave deve ser concedida. Selecione Administrador para permitir que um usuário com essa chave use APIs no nível administrativo mais amplo e avançado. Selecione Editor ou Visualizador para limitar os usuários das chaves a esses níveis de competência. Para obter mais informações, consulte as tabelas anteriores.
-
Em Tempo de vida, especifique por quanto tempo deseja que a chave seja válida. O máximo é 30 dias (um mês). Você insere um número e uma letra. As letras válidas são s para segundos, m para minutos, h para horas, d para dias, w para semanas e M para mês. Por exemplo, 12h são 12 horas e 1M é um mês (30 dias).
É altamente recomendável que você defina o tempo de vida da chave por um período mais curto, como algumas horas ou menos. Dessa forma, há menos riscos do que ter chaves de API válidas por muito tempo.
-
Escolha Adicionar.
-
(Opcional) Você pode automatizar a criação de chaves de API com a API Create API Key usando o Terraform. Para obter mais informações sobre como automatizar a criação de chaves de API usando o Terraform, consulte Creating Grafana API Key using Terraform
.
Criar uma chave de API do espaço de trabalho do Amazon Managed Grafana usando a AWS CLI
Para criar uma chave de API de espaço de trabalho do Amazon Managed Grafana usando a AWS CLI
No exemplo a seguir, substitua key_name, key_role, seconds_to_live e workspace_id pelas suas informações. Para saber mais sobre o formato de key-name, key-role e seconds-to-live, consulte https://docs.aws.amazon.com/grafana/latest/APIReference/API_CreateWorkspaceApiKey.html no guia de APIs.
aws grafana create-workspace-api-key --key-name "key_name" --key-role "key_role" --seconds-to-liveseconds_to_live--workspace-id "workspace_id"
Veja a seguir uma resposta de exemplo da CLI:
Você pode encontrar o workspace_id do seu espaço de trabalho executando o seguinte comando:
aws grafana list-workspaces
