API Snapshot - Amazon Managed Grafana
Créer un nouveau shapshotObtenir la liste des instantanésObtenez un instantané par cléSupprimer un instantané par toucheSupprimer un instantané par DeleteKey

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

API Snapshot

Utilisez l'API Snapshot pour travailler avec des instantanés dans un espace de travail Amazon Managed Grafana.

Note

Pour utiliser une API Grafana avec votre espace de travail Amazon Managed Grafana, vous devez disposer d'un jeton d'API Grafana valide. Vous l'incluez dans le Authorization champ de la demande d'API. Pour plus d'informations sur la création d'un jeton pour authentifier vos appels d'API, consultezAuthentifiez-vous avec des jetons.

Créer un nouveau shapshot

POST /api/snapshots

Exemple de demande

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
    }

Schéma de corps JSON :

  • tableau de bord — (Obligatoire) Le modèle de tableau de bord complet.

  • name — (Facultatif) Nom du cliché.

  • expires — (Facultatif) Date à laquelle l'instantané doit expirer, en secondes. La valeur par défaut est de ne jamais expirer.

  • external — (Facultatif) Enregistrez le snapshot sur un serveur externe plutôt que localement. La valeur par défaut est false.

  • clé — (Obligatoire si external c'est le castrue) Définissez une clé unique.

  • deletekey — (Obligatoire external le cas échéanttrue) Une clé unique à utiliser pour supprimer l'instantané. Cela est différent du key fait que seul le créateur peut supprimer l'instantané.

Note

Lorsque vous créez un instantané à l'aide de l'API, vous devez fournir la charge utile complète du tableau de bord, y compris les données du cliché. Ce point de terminaison est conçu pour l'interface utilisateur de Grafana.

Exemple de réponse

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

Clés :

  • DeleteKey — Clé générée pour être utilisée pour supprimer l'instantané.

  • clé : clé générée pour partager le tableau de bord.

Obtenir la liste des instantanés

GET /api/dashboard/snapshots

Paramètres de requête :

  • query — Requête de recherche

  • limit — Limite le nombre de résultats renvoyés

Exemple de demande

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

Exemple de réponse

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

Obtenez un instantané par clé

GET /api/snapshots/:key

Exemple de demande

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

Exemple de réponse

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

Supprimer un instantané par touche

DELETE /api/snapshots/:key

Exemple de demande

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

Exemple de réponse

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}

Supprimer un instantané par DeleteKey

Cet appel d'API peut être utilisé sans authentification en utilisant la clé de suppression secrète pour l'instantané.

GET /api/snapshots-delete/:deleteKey

Exemple de demande

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

Exemple de réponse

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}