API Snapshot - Grafana gestito da Amazon
Crea una nuova istantaneaOttieni un elenco di istantaneeOttieni un'istantanea per chiaveElimina l'istantanea per chiaveElimina istantanea tramite DeleteKey

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

API Snapshot

Usa l'API Snapshot per lavorare con le istantanee in un'area di lavoro Amazon Managed Grafana.

Nota

Per utilizzare un'API Grafana con il tuo spazio di lavoro Amazon Managed Grafana, devi disporre di un token API Grafana valido. Lo includi nel Authorization campo della richiesta API. Per informazioni su come creare un token per autenticare le chiamate API, consultaAutenticazione con token.

Crea una nuova istantanea

POST /api/snapshots

Richiesta di esempio

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
    }

Schema del corpo JSON:

  • dashboard — (Obbligatorio) Il modello di dashboard completo.

  • name — (Facoltativo) Un nome per l'istantanea.

  • expires — (Facoltativo) Quando l'istantanea deve scadere, in secondi. L'impostazione predefinita è non scadere mai.

  • external — (Facoltativo) Salva l'istantanea su un server esterno anziché localmente. Il valore predefinito è false.

  • key — (Obbligatorio se lo external ètrue) Definisce una chiave univoca.

  • deletekey — (Obbligatorio se lo external ètrue) Una chiave univoca da utilizzare per eliminare l'istantanea. È diverso dal key fatto che solo l'autore può eliminare l'istantanea.

Nota

Quando si crea un'istantanea utilizzando l'API, è necessario fornire il payload completo del dashboard, compresi i dati dell'istantanea. Questo endpoint è progettato per l'interfaccia utente Grafana.

Example response

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

Chiavi:

  • DeleteKey: una chiave generata da utilizzare per eliminare l'istantanea.

  • chiave: una chiave generata per condividere la dashboard.

Ottieni un elenco di istantanee

GET /api/dashboard/snapshots

Parametri di interrogazione:

  • query: query di ricerca

  • limit: limita il numero di risultati restituiti

Richiesta di esempio

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

Example response

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

Ottieni un'istantanea per chiave

GET /api/snapshots/:key

Richiesta di esempio

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

Example response

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

Elimina l'istantanea per chiave

DELETE /api/snapshots/:key

Richiesta di esempio

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

Example response

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}

Elimina istantanea tramite DeleteKey

Questa chiamata API può essere utilizzata senza autenticazione utilizzando la chiave di eliminazione segreta per l'istantanea.

GET /api/snapshots-delete/:deleteKey

Richiesta di esempio

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

Example response

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}