Snapshot-API

Verwenden Sie die Snapshot-API, um mit Snapshots in einem Amazon Managed Grafana-Arbeitsbereich zu arbeiten.

Anmerkung

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

Erstellen Sie einen neuen Snapshot

POST /api/snapshots

Beispielanforderung

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

    {
      "dashboard": {
        "editable":false,
        "hideControls":true,
        "nav":[
        {
          "enable":false,
        "type":"timepicker"
        }
        ],
        "rows": [
          {

          }
        ],
        "style":"dark",
        "tags":[],
        "templating":{
          "list":[
          ]
        },
        "time":{
        },
        "timezone":"browser",
        "title":"Home",
        "version":5
        },
      "expires": 3600
    }

JSON-Textschema:

• Dashboard — (Erforderlich) Das vollständige Dashboard-Modell.

• name — (Optional) Ein Name für den Snapshot.

• expires — (Optional) Wann der Snapshot ablaufen soll, in Sekunden. Die Standardeinstellung ist, dass es nie abläuft.

• external — (Optional) Speichern Sie den Snapshot nicht lokal, sondern auf einem externen Server. Standard ist „false“.

• key — (Erforderlich, falls external vorhandentrue) Definiert einen eindeutigen Schlüssel.

• deletekey — (Erforderlich, falls vorhanden externaltrue) Ein eindeutiger Schlüssel, der zum Löschen des Snapshots verwendet wird. Es unterscheidet sich von key so, dass nur der Ersteller den Snapshot löschen kann.

Anmerkung

Wenn Sie einen Snapshot mithilfe der API erstellen, müssen Sie die vollständige Dashboard-Nutzlast einschließlich der Snapshot-Daten bereitstellen. Dieser Endpunkt ist für die Grafana-Benutzeroberfläche konzipiert.

Beispielantwort

HTTP/1.1 200
    Content-Type: application/json
    {
      "deleteKey":"XXXXXXX",
      "deleteUrl":"myurl/api/snapshots-delete/XXXXXXX",
      "key":"YYYYYYY",
      "url":"myurl/dashboard/snapshot/YYYYYYY",
      "id": 1,
    }

Schlüssel:

• deleteKey — Ein Schlüssel, der generiert wurde, um den Snapshot zu löschen.

• Schlüssel — Ein Schlüssel, der generiert wurde, um das Dashboard gemeinsam zu nutzen.

Liste der Schnappschüsse abrufen

GET /api/dashboard/snapshots

Parameter abfragen:

• Abfrage — Suchabfrage

• limit — Beschränkt die Anzahl der zurückgegebenen Ergebnisse

Beispielanforderung

GET /api/dashboard/snapshots HTTP/1.1
Accept: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

[
  {
    "id":8,
    "name":"Home",
    "key":"YYYYYYY",
    "orgId":1,
    "userId":1,
    "external":false,
    "externalUrl":"",
    "expires":"2200-13-32T25:23:23+02:00",
    "created":"2200-13-32T28:24:23+02:00",
    "updated":"2200-13-32T28:24:23+02:00"
  }
]

Schnappschuss nach Schlüssel abrufen

GET /api/snapshots/:key

Beispielanforderung

GET /api/snapshots/YYYYYYY HTTP/1.1
Accept: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

{
  "meta":{
    "isSnapshot":true,
    "type":"snapshot",
    "canSave":false,
    "canEdit":false,
    "canStar":false,
    "slug":"",
    "expires":"2200-13-32T25:23:23+02:00",
    "created":"2200-13-32T28:24:23+02:00"
  },
  "dashboard": {
    "editable":false,
    "hideControls":true,
    "nav": [
      {
        "enable":false,
        "type":"timepicker"
      }
    ],
    "rows": [
      {

      }
    ],
    "style":"dark",
    "tags":[],
    "templating":{
      "list":[
      ]
    },
    "time":{
    },
    "timezone":"browser",
    "title":"Home",
    "version":5
  }
}

Schnappschuss nach Schlüssel löschen

DELETE /api/snapshots/:key

Beispielanforderung

DELETE /api/snapshots/YYYYYYY HTTP/1.1
Accept: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

{"message":"Snapshot deleted. It might take an hour before it's cleared from any CDN caches.", "id": 1}

Schnappschuss mit DeleteKey löschen

Dieser API-Aufruf kann ohne Authentifizierung verwendet werden, indem der geheime Löschschlüssel für den Snapshot verwendet wird.

GET /api/snapshots-delete/:deleteKey

Beispielanforderung

GET /api/snapshots-delete/XXXXXXX HTTP/1.1
Accept: application/json

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

{"message":"Snapshot deleted. It might take an hour before it's cleared from any CDN caches.", "id": 1}