View a markdown version of this page

API de puntos de contacto de alertas - Amazon Managed Grafana
Enumere los tipos de puntos de contactoExporta puntos de contactoPuntos finales de punto de contacto obsoletos

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.

API de puntos de contacto de alertas

En la versión 13 de Grafana, las notificaciones se gestionan mediante las alertas unificadas de Grafana. La API de los canales de notificación antiguos (los /api/alert-notifications puntos finales) se eliminó junto con las alertas antiguas en la versión 11 de Grafana y ya no está disponible. En su lugar, usa la API de aprovisionamiento de alertas para trabajar con los puntos de contacto, que son el sustituto unificado de las alertas para los canales de notificación.

nota

Para usar una API de Grafana con tu espacio de trabajo de Grafana gestionado por Amazon, debes tener un token de cuenta de servicio válido. Lo incluye en el campo Authorization de la solicitud de API.

nota

Las alertas que proporcionan puntos de contacto a los puntos de contacto y que enumeran, crean, actualizan o eliminan puntos de contacto (, GET POSTPUT, etc.) están en desuso. DELETE /api/v1/provisioning/contact-points Las respuestas de estos puntos finales incluyen un Warning encabezado y un encabezado con una fecha deX-API-Deprecation-Date. 2026-04-07 En este tema se documentan los puntos finales que no están GET /api/v1/provisioning/contact-points/export en desuso, GET /api/alert-notifiers y se enumeran los puntos finales obsoletos únicamente como referencia.

Enumere los tipos de puntos de contacto

Devuelve la lista de tipos de puntos de contacto (notificadores) disponibles en tu espacio de trabajo de Grafana gestionado por Amazon. Utilice este punto final para descubrir qué tipos de puntos de contacto puede configurar y las opciones que admite cada tipo.

GET /api/alert-notifiers

Parámetros de consulta

  • version— (Opcional) Configúrelo en 2 para devolver el esquema de tipos de integración completo para cada tipo de punto de contacto. Si se omite, el punto final devuelve la lista predeterminada de tipos de puntos de contacto.

Ejemplo de solicitud

GET /api/alert-notifiers HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer 1234abcd567exampleToken890

Respuesta

La respuesta es una matriz JSON en la que cada elemento describe un tipo de punto de contacto disponible. Cada elemento incluye el identificador de tipo (type), la pantalla namedescription, a y la configuración options que admite el tipo.

Exporta puntos de contacto

Devuelve los puntos de contacto definidos en tu espacio de trabajo de Grafana gestionado por Amazon en un formato que puedes utilizar para aprovisionar las alertas como código. Este punto final no está obsoleto.

GET /api/v1/provisioning/contact-points/export

Parámetros de consulta

  • name— (Opcional) Filtre los puntos de contacto exportados por nombre de punto de contacto.

  • decrypt— (Opcional) Si se debe descifrar e incluir una configuración segura en la exportación. El valor predeterminado es false.

  • format— (Opcional) El formato de salida de la exportación, como jsonyaml, o hcl (Terraform).

Ejemplo de solicitud

GET /api/v1/provisioning/contact-points/export?format=yaml HTTP/1.1
Accept: application/json
Authorization: Bearer 1234abcd567exampleToken890

Respuesta

Devuelve los puntos de contacto en el formato solicitado, adecuado para su uso con el aprovisionamiento de archivos o con Terraform. De forma predeterminada, la configuración segura está redactada a menos que se establezca así. decrypt true

Puntos finales de punto de contacto obsoletos

Los siguientes puntos finales de aprovisionamiento de alertas administran los puntos de contacto, pero están en desuso. Las respuestas incluyen un Warning encabezado y un X-API-Deprecation-Date encabezado con una fecha de. 2026-04-07 Se enumeran aquí solo como referencia y es posible que se eliminen en una versión futura.

  • GET /api/v1/provisioning/contact-points— Devuelve todos los puntos de contacto. Acepta un parámetro de name consulta opcional para filtrar por nombre de punto de contacto.

  • POST /api/v1/provisioning/contact-points— Crea un punto de contacto.

  • PUT /api/v1/provisioning/contact-points/{UID}— Actualiza el punto de contacto con el especificadoUID.

  • DELETE /api/v1/provisioning/contact-points/{UID}— Elimina el punto de contacto con el especificadoUID.

El objeto de punto de contacto utilizado por estos puntos finales incluye los siguientes campos.

  • uid— (Opcional) Un identificador único definido por el usuario para el punto de contacto.

  • name— (Obligatorio) El nombre del punto de contacto. Los puntos de contacto que comparten un nombre se agrupan.

  • type— (Obligatorio) El tipo de punto de contactoemail, comoslack, owebhook.

  • settings— (Obligatorio) Un objeto específico de un tipo que contiene la configuración del punto de contacto.

  • disableResolveMessage— (Opcional) Si se debe suprimir la notificación que se envía cuando se resuelve una alerta.

  • provenance— (Read-only) Indica cómo se aprovisionó el punto de contacto.