Anmerkungs-API

Verwenden Sie die Annotations-API zum Erstellen, Aktualisieren, Löschen und Arbeiten mit Anmerkungen im Amazon Managed Grafana Workspace.

Anmerkungen werden in der Grafana-Datenbank des Workspace gespeichert (sq, mysql oder postgres). Anmerkungen können globale Anmerkungen sein, die in jedem Dashboard angezeigt werden können, indem eine Anmerkungsdatenquelle konfiguriert wird. Anmerkungen werden nach Tags gefiltert. Oder sie können an einen Bereich in einem Dashboard gebunden und nur in diesem Bereich angezeigt werden.

Anmerkung

Um eine Grafana-API mit Ihrem Amazon Managed Grafana Workspace zu verwenden, benötigen Sie ein gültiges Grafana-API-Token. Sie fügen dies in das Authorization Feld in der API-Anforderung ein. Informationen zum Erstellen eines Tokens zur Authentifizierung Ihrer API-Aufrufe finden Sie unter Authentifizieren mit Tokens.

Anmerkungen finden

GET /api/annotations?from=1506676478816&to=1507281278816&tags=tag1&tags=tag2&limit=100

Beispielanforderung

GET /api/annotations?from=1506676478816&to=1507281278816&tags=tag1&tags=tag2&limit=100 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Abfrageparameter:

• from – (Optional) Epoch datetime in Millisekunden.

• bis – (Optional) Epoch datetime in Millisekunden.

• limit – (Optional) Maximale Anzahl der zurückgegebenen Ergebnisse. Der Standardwert ist 100.

• alertid – (Optional) FInd-Anmerkungen für die angegebene Warnung.

• dashboardId – (Optional) Suchen Sie nach Anmerkungen, die auf das angegebene Dashboard beschränkt sind.

• panelId – (Optional) Suchen Sie nach Anmerkungen, die auf das angegebene Panel beschränkt sind.

• userId – (Optional) Suchen Sie nach Anmerkungen, die vom angegebenen Benutzer erstellt wurden.

• Typ – (Optional) Geben Sie an, um Warnungen oder vom Benutzer erstellte Anmerkungen zurückzugeben. Werte sind alert und annotation.

• Tags – (Optional) Verwenden Sie diese Option, um globale Anmerkungen zu filtern. Globale Anmerkungen sind Anmerkungen aus einer Anmerkungsdatenquelle, die nicht speziell mit einem Dashboard oder Bereich verbunden sind. Um eine „AND“-Filterung mit mehreren Tags durchzuführen, geben Sie den Tags-Parameter mehrmals an. Beispiel: tags=tag1&tags=tag2 Dies sind Grafana-Tags, keine AWS Tags.

Beispielantwort

HTTP/1.1 200
Content-Type: application/json
[
    {
        "id": 1124,
        "alertId": 0,
        "dashboardId": 468,
        "panelId": 2,
        "userId": 1,
        "userName": "",
        "newState": "",
        "prevState": "",
        "time": 1507266395000,
        "timeEnd": 1507266395000,
        "text": "test",
        "metric": "",
        "tags": [
            "tag1",
            "tag2"
        ],
        "data": {}
    },
    {
        "id": 1123,
        "alertId": 0,
        "dashboardId": 468,
        "panelId": 2,
        "userId": 1,
        "userName": "",
        "newState": "",
        "prevState": "",
        "time": 1507265111000,
        "text": "test",
        "metric": "",
        "tags": [
            "tag1",
            "tag2"
        ],
        "data": {}
    }
]

Anmerkung erstellen

POST /api/annotations

Erstellt eine Anmerkung in der Grafana-Datenbank des Workspace. Die Felder dashboardId und panelId sind optional. Wenn sie nicht angegeben sind, wird eine globale Anmerkung erstellt und kann in jedem Dashboard abgefragt werden, das die Datenquelle für Grafana-Anmerkungen hinzufügt. Achten Sie beim Erstellen einer Regionsanmerkung darauf, die -timeEndEigenschaft einzubeziehen.

Das Format für time und timeEnd sollte Epochenzahlen in Millisekundenauflösung sein.

Beispielanforderung

POST /api/annotations HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
  "dashboardId":468,
  "panelId":1,
  "time":1507037197339,
  "timeEnd":1507180805056,
  "tags":["tag1","tag2"],
  "text":"Annotation Description"
}

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

{
    "message":"Annotation added",
    "id": 1,
}

Anmerkung im Graphitformat erstellen

POST /api/annotations/graphite

Erstellt eine Anmerkung unter Verwendung eines Graphite-kompatiblen Ereignisformats. Die Felder when und data sind optional. Wenn nicht angegeben when ist, wird die aktuelle Uhrzeit als Zeitstempel der Anmerkung verwendet. Das tags Feld kann sich auch im Format Graphite 0.10.0 befinden (Zeichenfolge mit mehreren Tags, die durch ein Leerzeichen getrennt werden).

Beispielanforderung

POST /api/annotations/graphite HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
  "what": "Event - deploy",
  "tags": ["deploy", "production"],
  "when": 1467844481,
  "data": "deploy of master branch happened at Wed Jul 6 22:34:41 UTC 2016"
}

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

{
    "message":"Graphite annotation added",
    "id": 1
}

Anmerkung aktualisieren

PUT /api/annotations/:id

Datumt alle Eigenschaften einer Anmerkung, die der angegebenen ID entspricht. Um nur bestimmte Eigenschaften zu aktualisieren, verwenden Sie die Patch Annotation-Operation.

Beispielanforderung

PUT /api/annotations/1141 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
Content-Type: application/json

{
  "time":1507037197339,
  "timeEnd":1507180805056,
  "text":"Annotation Description",
  "tags":["tag3","tag4","tag5"]
}

Beispielantwort:

HTTP/1.1 200
Content-Type: application/json

{
    "message":"Annotation updated"
}

Patch-Anmerkung

PATCH /api/annotations/:id

Aktualisiert eine oder mehrere Eigenschaften einer Anmerkung, die der angegebenen ID entspricht. Dieser Vorgang unterstützt derzeit die Aktualisierung der timeEnd Eigenschaften text, tagstime, und .

Beispielanforderung:

PATCH /api/annotations/1145 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
Content-Type: application/json
       
{
   "text":"New Annotation Description",
   "tags":["tag6","tag7","tag8"]
}

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

{
    "message":"Annotation patched"
}

Anmerkung nach ID löschen

DELETE /api/annotations/:id

Löscht die Anmerkung, die der angegebenen ID entspricht.

Beispielanforderung

DELETE /api/annotations/1 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

{
    "message":"Annotation deleted"
}