API für Alarmierung von Kontaktstellen

In Grafana-Version 13 werden Benachrichtigungen über das einheitliche Alerting von Grafana verwaltet. Die veraltete API für Benachrichtigungskanäle (die /api/alert-notifications Endpunkte) wurde zusammen mit den älteren Benachrichtigungen in Grafana-Version 11 entfernt und ist nicht mehr verfügbar. Verwenden Sie stattdessen die API zur Bereitstellung von Benachrichtigungen, um mit Kontaktpunkten zu arbeiten, die als einheitlicher Ersatz für Benachrichtigungen für Benachrichtigungskanäle dienen.

Anmerkung

Um eine Grafana-API mit Ihrem Amazon Managed Grafana-Workspace verwenden zu können, benötigen Sie ein gültiges Dienstkonto-Token. Sie fügen dies in das Authorization Feld in der API-Anfrage ein.

Anmerkung

Die Kontaktpunkt-Endpunkte für die Bereitstellung von Alerting, die Kontaktpunkte auflisten, erstellen, aktualisieren oder löschen (GET,POST, und DELETE on/api/v1/provisioning/contact-points)PUT, sind veraltet. Antworten von diesen Endpunkten enthalten eine Warning Kopfzeile und eine X-API-Deprecation-Date Kopfzeile mit dem Datum von. 2026-04-07 In diesem Thema werden die Endpunkte, die nicht als veraltet gelten, vollständig dokumentiert GET /api/alert-notifiers und die GET /api/v1/provisioning/contact-points/export veralteten Endpunkte werden nur zu Referenzzwecken aufgeführt.

Listet die Kontaktpunkttypen auf

Gibt die Liste der Kontaktpunkttypen (Notifier) zurück, die in Ihrem Amazon Managed Grafana-Arbeitsbereich verfügbar sind. Verwenden Sie diesen Endpunkt, um herauszufinden, welche Kontaktpunkttypen Sie konfigurieren können und welche Optionen jeder Typ unterstützt.

GET /api/alert-notifiers

Abfrageparameter

• version— (Optional) Auf setzen, 2 um das vollständige Integrationstypschema für jeden Kontaktpunkttyp zurückzugeben. Wenn der Endpunkt weggelassen wird, gibt er die Standardliste der Kontaktpunkttypen zurück.

Beispielanforderung

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

Antwort

Die Antwort ist ein JSON-Array, in dem jedes Element einen verfügbaren Kontaktpunkttyp beschreibt. Jedes Element enthält den Typbezeichner (type), die Anzeige namedescription, a und die Konfigurationoptions, die der Typ unterstützt.

Kontaktpunkte exportieren

Gibt die in Ihrem Amazon Managed Grafana-Workspace definierten Kontaktpunkte in einem Format zurück, das Sie zur Bereitstellung von Benachrichtigungen als Code verwenden können. Dieser Endpunkt ist nicht veraltet.

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

Abfrageparameter

• name— (Optional) Filtert die exportierten Kontaktpunkte nach dem Namen der Kontaktstelle.

• decrypt— (Optional) Ob sichere Einstellungen entschlüsselt und in den Export aufgenommen werden sollen. Standardeinstellung: false.

• format— (Optional) Das Ausgabeformat für den Export, z. B. jsonyaml, oder hcl (Terraform).

Beispielanforderung

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

Antwort

Gibt die Kontaktpunkte im angeforderten Format zurück, das für die Verwendung mit Dateibereitstellung oder Terraform geeignet ist. Standardmäßig werden sichere Einstellungen unkenntlich gemacht, es sei denn, Sie setzen auf. decrypt true

Veraltete Kontaktpunkt-Endpunkte

Die folgenden Endpunkte zur Bereitstellung von Benachrichtigungen verwalten Kontaktpunkte, sind jedoch veraltet. Die Antworten enthalten eine Warning Kopfzeile und eine X-API-Deprecation-Date Kopfzeile mit dem Datum von. 2026-04-07 Sie sind hier nur als Referenz aufgeführt und könnten in einer future Version entfernt werden.

• GET /api/v1/provisioning/contact-points— Gibt alle Kontaktpunkte zurück. Akzeptiert einen optionalen name Abfrageparameter zum Filtern nach dem Namen der Kontaktstelle.

• POST /api/v1/provisioning/contact-points— Erzeugt einen Kontaktpunkt.

• PUT /api/v1/provisioning/contact-points/{UID}— Aktualisiert den Kontaktpunkt mit dem angegebenenUID.

• DELETE /api/v1/provisioning/contact-points/{UID}— Löscht den Kontaktpunkt mit dem angegebenenUID.

Das von diesen Endpunkten verwendete Kontaktpunktobjekt umfasst die folgenden Felder.

• uid— (Optional) Eine benutzerdefinierte eindeutige Kennung für die Kontaktstelle.

• name— (Erforderlich) Der Name der Kontaktstelle. Kontaktstellen, die einen gemeinsamen Namen haben, werden zu Gruppen zusammengefasst.

• type— (Erforderlich) Der Kontaktpunkttyp, z. B.email,slack, oderwebhook.

• settings— (Erforderlich) Ein typspezifisches Objekt, das die Konfiguration für den Kontaktpunkt enthält.

• disableResolveMessage— (Optional) Ob die Benachrichtigung unterdrückt werden soll, die gesendet wird, wenn eine Warnung behoben wird.

• provenance— (Read-only) Gibt an, wie der Kontaktpunkt bereitgestellt wurde.