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 Anmerkungen

Verwenden Sie die Annotations API, um Anmerkungen im Amazon Managed Grafana-Arbeitsbereich zu erstellen, zu aktualisieren, zu löschen und mit ihnen zu arbeiten.

Anmerkungen werden in der Grafana-Datenbank des Workspace (sqlite, mysql oder postgres) gespeichert. Anmerkungen können globale Anmerkungen sein, die auf jedem Dashboard angezeigt werden können, indem eine Annotationsdatenquelle konfiguriert wird. Anmerkungen werden nach Tags gefiltert. Sie können auch mit einem Bereich auf einem Dashboard verknüpft und nur in diesem Bereich angezeigt werden.

Suchen Sie nach Anmerkungen

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

Parameter abfragen:

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, die in jedem Dashboard abgefragt werden kann, das die Datenquelle für Grafana-Anmerkungen hinzufügt. Achten Sie beim Erstellen einer Regionsanmerkung darauf, dass Sie die Eigenschaft angeben. timeEnd

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,
}

Erstellen Sie eine Anmerkung im Graphitformat

POST /api/annotations/graphite

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

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

Aktualisiert alle Eigenschaften einer Anmerkung, die der angegebenen ID entspricht. Um nur bestimmte Eigenschaften zu aktualisieren, verwenden Sie den Vorgang Patch Annotation.

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"]
}

Beispiel für eine Antwort:

HTTP/1.1 200
Content-Type: application/json

{
    "message":"Annotation updated"
}

Anmerkung zum Patch

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.

Beispiel für eine Anfrage:

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"
}