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 da Grafana
Uma forma de acessar as APIs da Grafana é usar uma chave de API, 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 aplicativos que interagem com as APIs da 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 uma função para a chave. A função determina o nível de poder administrativo que os usuários da chave têm.
As tabelas a seguir mostram as permissões concedidas às funções de Administrador, Editor e Visualizador. A primeira tabela mostra as permissões organizacionais gerais. Nessa tabela, Completo significa a capacidade de visualizar, editar, adicionar permissões e excluir permissões. A coluna Explorar mostra se a função pode usar a visualização Explorar. A coluna Outras permissões mostra se a função tem permissões para gerenciar usuários, equipes, plug-ins e configurações organizacionais.
| Função | Painéis | Listas de reprodução | Pastas | Explorar | 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 em nível de painel e pasta que você pode definir. Elas são diferentes das funções de Administrador, Editor e Visualizador.
| Função | Painéis | Pastas | Alterar permissões. |
|---|---|---|---|
|
Visão |
Visão | Visão | Não |
|
Edite |
Crie, edite | 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 a função organizacional de Editor e, em seguida, atribuir a esse usuário somente as permissões de exibição para um painel, a permissão de exibição mais restritiva não terá efeito porque o usuário tem acesso total à edição devido à função de editor.
Criação de 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 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
-
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 Amazon Managed Grafana.
-
Na página de detalhes do espaço de trabalho, escolha o URL exibido em URL do espaço de trabalho Grafana.
-
No menu lateral do console Grafana, faça uma pausa no ícone Configuração (engrenagem) e escolha Chaves de API.
-
Escolha Nova chave de API.
-
Insira um nome exclusivo para a chave.
-
Em Função, 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 poderoso. Selecione Editor ou Visualizador para limitar os usuários da chave a esses níveis de potência. Para obter mais informações, consulte as tabelas anteriores.
-
Em Time to live, especifique por quanto tempo você deseja que a chave seja válida. O máximo é de 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 é 1 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. Isso cria muito 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 Criação da chave de API Grafana
usando o Terraform.
Criação de uma chave de API do Amazon Managed Grafana Workspace usando AWS CLI
Para criar uma chave de API do Amazon Managed Grafana Workspace usando AWS CLI
No exemplo a seguir, substitua Para saber mais sobre o formato do nome da chave, da função da chave e seconds-to-live, consulte https://docs.aws.amazon.com/grafana/latest/APIReference/API_CreateWorkspaceApiKey.html o guia da API. key_name, key_role, seconds_to_live e workspace_id por suas próprias informações.
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 um exemplo de resposta da CLI:
Você pode encontrar o workspace_id do seu espaço de trabalho executando o seguinte comando:
aws grafana list-workspaces
