View a markdown version of this page

API für Warn- und Benachrichtigungskanäle - Amazon Managed Grafana
Holen Sie sich alle BenachrichtigungskanäleRuft alle Benachrichtigungskanäle ab (Lookup)Ruft alle Benachrichtigungskanäle nach UID abAlle Benachrichtigungskanäle nach ID abrufenBenachrichtigungskanal erstellenAktualisiere den Benachrichtigungskanal nach UIDAktualisiere den Benachrichtigungskanal nach IDBenachrichtigungskanal nach UID löschenBenachrichtigungskanal nach ID löschenTesten Sie den Benachrichtigungskanal

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

API für Warn- und Benachrichtigungskanäle

Verwenden Sie die Alerting Notification Channels API, um Benachrichtigungskanäle zu erstellen, zu aktualisieren, zu löschen und abzurufen.

Die Kennung (ID) eines Benachrichtigungskanals ist ein automatisch inkrementierender numerischer Wert, der nur pro Workspace eindeutig ist. Die eindeutige Kennung (UID) eines Benachrichtigungskanals kann verwendet werden, um einen Ordner zwischen mehreren Arbeitsbereichen eindeutig zu identifizieren. Sie wird automatisch generiert, wenn Sie beim Erstellen eines Benachrichtigungskanals keine angeben. Die UID ermöglicht einen konsistenten URLs Zugriff auf Benachrichtigungskanäle und die Synchronisierung von Benachrichtigungskanälen zwischen mehreren Amazon Managed Grafana-Arbeitsbereichen.

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.

Holen Sie sich alle Benachrichtigungskanäle

Gibt alle Benachrichtigungskanäle zurück, zu deren Anzeige der authentifizierte Benutzer berechtigt ist.

GET /api/alert-notifications

Beispielanforderung

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

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

[
  {
    "id": 1,
    "uid": "sns-uid",
    "name": "test",
    "type": "sns",
    "isDefault": false,
    "sendReminder": false,
    "disableResolveMessage": false,
    "frequency": "",
    "created": "2023-09-08T19:57:56Z",
    "updated": "2023-09-08T19:57:56Z",
    "settings": {
      "authProvider": "default",
      "autoResolve": true,
      "httpMethod": "POST",
      "messageFormat": "json",
      "severity": "critical",
      "topic": "<SNS-TOPIC-ARN>",
      "uploadImage": false
    },
    "secureFields": {}
  }
]

Ruft alle Benachrichtigungskanäle ab (Lookup)

Gibt alle Benachrichtigungskanäle zurück, jedoch mit weniger detaillierten Informationen. Zugänglich für jeden authentifizierten Benutzer und wird hauptsächlich zur Bereitstellung von Warnmeldungskanälen in der Benutzeroberfläche der Grafana-Workspace-Konsole bei der Konfiguration von Warnungsregeln verwendet.

GET /api/alert-notifications/lookup

Beispielanforderung

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

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

[
  {
    "id": 1,
    "uid": "sns-uid",
    "name": "test",
    "type": "sns",
    "isDefault": false
  },
  {
    "id": 2,
    "uid": "slack-uid",
    "name": "Slack",
    "type": "slack",
    "isDefault": false
  }
]

Ruft alle Benachrichtigungskanäle nach UID ab

GET /api/alert-notifications/uid/:uid

Beispielanforderung

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

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

{
  "id": 1,
  "uid": "sns-uid",
  "name": "test",
  "type": "sns",
  "isDefault": false,
  "sendReminder": false,
  "disableResolveMessage": false,
  "frequency": "",
  "created": "2023-09-08T19:57:56Z",
  "updated": "2023-09-08T19:57:56Z",
  "settings": {
    "authProvider": "default",
    "autoResolve": true,
    "httpMethod": "POST",
    "messageFormat": "json",
    "severity": "critical",
    "topic": "<SNS-TOPIC-ARN>",
    "uploadImage": false
  },
  "secureFields": {}
}

Alle Benachrichtigungskanäle nach ID abrufen

GET /api/alert-notifications/:id

Beispielanforderung

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

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

{
  "id": 1,
  "uid": "sns-uid",
  "name": "test",
  "type": "sns",
  "isDefault": false,
  "sendReminder": false,
  "disableResolveMessage": false,
  "frequency": "",
  "created": "2023-09-08T19:57:56Z",
  "updated": "2023-09-08T19:57:56Z",
  "settings": {
    "authProvider": "default",
    "autoResolve": true,
    "httpMethod": "POST",
    "messageFormat": "json",
    "severity": "critical",
    "topic": "<SNS-TOPIC-ARN>",
    "uploadImage": false
  },
  "secureFields": {}
}

Benachrichtigungskanal erstellen

Welche Benachrichtigungskanäle von Amazon Managed Grafana unterstützt werden, finden Sie in der Liste der unterstützten Notifier unter. Mit Kontaktstellen arbeiten

Verwenden Sie in Grafana-Version 12 die Alerting Provisioning API, um Kontaktpunkte zu erstellen. Der /api/alert-notifications Legacy-Endpunkt ist nicht mehr verfügbar.

Beispielanforderung

POST /api/v1/provisioning/contact-points HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer 1234abcd567exampleToken890

{
  "uid": "new-sns-uid",
  "name": "sns alert notification",
  "type": "sns",
  "isDefault": false,
  "sendReminder": false,
  "settings": {
    "topic_arn": "<SNS-TOPIC-ARN>",
    "subject": "<SUBJECT>"
  }
}

Aktualisiere den Benachrichtigungskanal nach UID

PUT /api/alert-notifications/uid/:uid

Beispielanforderung

PUT /api/alert-notifications/uid/sns-uid HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer 1234abcd567exampleToken890

{
  "uid": "sns-uid", // optional
  "name": "sns alert notification",  //Required
  "type":  "sns", //Required
  "isDefault": false,
  "sendReminder": true,
  "frequency": "15m",
  "settings": {
    "authProvider": "default",
    "autoResolve": true,
    "httpMethod": "POST",
    "messageFormat": "json",
    "severity": "critical",
    "topic": "<SNS-TOPIC-ARN>",
    "uploadImage": false
  }
}

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

{
  "id": 1,
  "uid": "sns-uid",
  "name": "sns alert notification",
  "type": "sns",
  "isDefault": false,
  "sendReminder": true,
  "frequency": "15m",
  "settings": {
    "authProvider": "default",
    "autoResolve": true,
    "httpMethod": "POST",
    "messageFormat": "json",
    "severity": "critical",
    "topic": "<SNS-TOPIC-ARN>",
    "uploadImage": false
  },
  "created": "2017-01-01 12:34",
  "updated": "2017-01-01 12:34"
}

Aktualisiere den Benachrichtigungskanal nach ID

PUT /api/alert-notifications/:id

Beispielanforderung

PUT /api/alert-notifications/1 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer 1234abcd567exampleToken890

{
  "id": 1,
  "uid": "sns-uid", // optional
  "name": "sns alert notification",  //Required
  "type":  "sns", //Required
  "isDefault": false,
  "sendReminder": true,
  "frequency": "15m",
  "settings": {
    "authProvider": "default",
    "autoResolve": true,
    "httpMethod": "POST",
    "messageFormat": "json",
    "severity": "critical",
    "topic": "<SNS-TOPIC-ARN>",
    "uploadImage": false
  }
}

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

{
  "id": 1,
  "uid": "sns-uid",
  "name": "sns alert notification",
  "type": "sns",
  "isDefault": false,
  "sendReminder": true,
  "frequency": "15m",
  "settings": {
    "authProvider": "default",
    "autoResolve": true,
    "httpMethod": "POST",
    "messageFormat": "json",
    "severity": "critical",
    "topic": "<SNS-TOPIC-ARN>",
    "uploadImage": false
  },
  "created": "2017-01-01 12:34",
  "updated": "2017-01-01 12:34"
}

Benachrichtigungskanal nach UID löschen

DELETE /api/alert-notifications/uid/:uid

Beispielanforderung

DELETE /api/alert-notifications/uid/sns-uid HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer 1234abcd567exampleToken890

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

{
  "message": "Notification deleted"
}

Benachrichtigungskanal nach ID löschen

DELETE /api/alert-notifications/:id

Beispielanforderung

DELETE /api/alert-notifications/1 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer 1234abcd567exampleToken890

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

{
  "message": "Notification deleted"
}

Testen Sie den Benachrichtigungskanal

Sendet eine Testbenachrichtigung für den angegebenen Benachrichtigungskanaltyp und die angegebenen Einstellungen.

POST /api/alert-notifications/test

Beispielanforderung

POST /api/alert-notifications/test HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer 1234abcd567exampleToken890

{
  "type":  "sns",
  "settings": {
    "authProvider": "default",
    "autoResolve": true,
    "httpMethod": "POST",
    "messageFormat": "json",
    "severity": "critical",
    "topic": "<SNS-TOPIC-ARN>",
    "uploadImage": false
  }
}

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

{
  "message": "Test notification sent"
}