Utilice claves de API para autenticarse con las API HTTP de Grafana - Amazon Managed Grafana

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Utilice claves de API para autenticarse con las API HTTP de Grafana

Una forma de acceder a las API de Grafana es utilizar una clave de API, que también se denomina token de API. Para crear una clave de API, utilice uno de los siguientes procedimientos. Una clave de API es válida durante el tiempo limitado que especifiques al crearla, hasta 30 días.

nota

En la versión 9 o posterior, se prefiere usar cuentas de servicio en lugar de claves de API. Las cuentas de servicio están sustituyendo a las claves de API como la principal forma de autenticar las aplicaciones que interactúan con las API de Grafana. Grafana Labs ha anunciado que las claves de API se eliminarán en una versión futura.

Al crear una clave de API, se especifica una función para la clave. El rol determina el nivel de poder administrativo que tienen los usuarios de la clave.

En las siguientes tablas se muestran los permisos concedidos a las funciones de administrador, editor y espectador. La primera tabla muestra los permisos organizativos generales. En esta tabla, por completo se entiende la posibilidad de ver, editar, añadir y eliminar permisos. La columna Explorar muestra si el rol puede usar la vista Explorar. La columna Otros permisos muestra si el rol tiene permisos para administrar los usuarios, los equipos, los complementos y la configuración de la organización.

Rol Paneles Lista de reproducción Carpetas Explora Origen de datos Otros permisos

Espectador

Visualización Visualización No No No No

Editor

Completo Completo Completo No No

Administrador

Completo Completo Completo Completo Completo

En la siguiente tabla se muestran los permisos adicionales a nivel de panel y carpeta que puede configurar. Son diferentes de las funciones de administrador, editor y espectador.

Rol Paneles Carpetas Cambiar los permisos

Ver

Visualización Visualización No

Editar

Crear, editar Visualización No

Administrador

Crear, editar, eliminar Crear, editar, eliminar
nota

Un permiso con un ámbito más amplio y un nivel de permiso inferior no surtirá efecto si existe una regla más general con más permisos. Por ejemplo, si asigna a un usuario la función de editor de la organización y, a continuación, solo le asigna los permisos de visualización para un panel, el permiso de visualización, que es más restrictivo, no surtirá efecto, ya que el usuario tiene pleno acceso de edición debido a su función de editor.

Creación de una clave de API de Grafana para usarla con las API de Grafana en el espacio de trabajo (consola)

nota

En los espacios de trabajo de Grafana gestionados por Amazon compatibles con la versión 10 y superior de Grafana, se eliminó la posibilidad de crear claves de API en el espacio de trabajo. Si su espacio de trabajo es un espacio de trabajo de Grafana versión 10, solo puede crear claves de API a través de la AWS CLI o la API.

Grafana Labs ha anunciado la eliminación de las claves de API para una versión futura. En su lugar, se recomienda utilizar cuentas de servicio.

Para crear una clave de API de Grafana para usarla con las API de Grafana en la consola de Workspace
  1. Abra la consola de Amazon Managed Grafana en https://console.aws.amazon.com/grafana/.

  2. En la esquina superior izquierda de la página, elija el icono de menú y, a continuación, elija Todos los espacios de trabajo.

  3. Elige el nombre del espacio de trabajo de Grafana gestionado por Amazon.

  4. En la página de detalles del espacio de trabajo, elige la URL que aparece debajo de la URL del espacio de trabajo de Grafana.

  5. En el menú lateral de la consola de Grafana, haz una pausa en el icono de Configuración (engranaje) y, a continuación, selecciona Claves de API.

  6. Selecciona Nueva clave de API.

  7. Introduzca un nombre único para la clave.

  8. En Rol, seleccione el nivel de acceso al que se va a conceder la clave. Seleccione Admin para permitir que un usuario con esta clave utilice las API en el nivel administrativo más amplio y potente. Seleccione Editor o Visor para limitar los usuarios de la clave a esos niveles de potencia. Para obtener más información, consulte las tablas anteriores.

  9. En Time to live, especifique cuánto tiempo desea que la clave sea válida. El máximo es de 30 días (un mes). Introduce un número y una letra. Las letras válidas son s para los segundos, m para los minutos, h para las horas, d para los días, w para las semanas y M para el mes. Por ejemplo, 12 h son 12 horas y 1 m es 1 mes (30 días).

    Le recomendamos encarecidamente que establezca el tiempo de vida de la clave para un período más corto, por ejemplo, unas pocas horas o menos. Esto supone un riesgo mucho menor que tener claves de API que sean válidas durante mucho tiempo.

  10. Elija Añadir.

  11. (Opcional) Puede automatizar la creación de claves de API con la API de creación de claves de API mediante Terraform. Para obtener más información sobre la automatización de la creación de claves de API con Terraform, consulte Creación de una clave de API de Grafana con Terraform.

Creación de una clave de API de espacio de trabajo de Grafana gestionado por Amazon mediante AWS CLI

Para crear una clave de API de espacio de trabajo de Grafana gestionado por Amazon mediante AWS CLI

En el siguiente ejemplo, sustituye key_name, key_role, seconds_to_live y workspace_id por tu propia información. Para obtener información sobre el formato del nombre clave, del rol clave y, consulte la guía de la API. 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"

El siguiente es un ejemplo de respuesta CLI:

create-workspace-api-key ejemplo de salida

Puedes encontrar el workspace_id de tu espacio de trabajo ejecutando el siguiente comando:

aws grafana list-workspaces