API de instantáneas - Amazon Managed Grafana
Cree una nueva captura de pantallaObtenga una lista de instantáneasObtenga una instantánea por claveElimine la instantánea por claveEliminar instantánea mediante DeleteKey

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

API de instantáneas

Usa la API de instantáneas para trabajar con instantáneas en un espacio de trabajo de Grafana gestionado por Amazon.

nota

Para usar una API de Grafana con tu espacio de trabajo de Grafana gestionado por Amazon, debes tener un token de API de Grafana válido. Lo incluyes en el Authorization campo de la solicitud de API. Para obtener información sobre cómo crear un token para autenticar tus llamadas a la API, consultaAutenticarse con fichas.

Cree una nueva captura de pantalla

POST /api/snapshots

Ejemplo de solicitud

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
    }

Esquema corporal de JSON:

  • panel: (obligatorio) el modelo de panel completo.

  • nombre: (opcional) un nombre para la instantánea.

  • caduca: (opcional) cuándo debe caducar la instantánea, en segundos. El valor predeterminado es que no caduque nunca.

  • externo: (opcional) guarda la instantánea en un servidor externo en lugar de guardarla localmente. La opción predeterminada es falso.

  • clave: (obligatorio si lo external estrue) Defina una clave única.

  • deletekey — (Obligatoria si la external haytrue) Una clave única que se utilizará para eliminar la instantánea. Es diferente, ya key que solo el creador puede eliminar la instantánea.

nota

Al crear una instantánea mediante la API, debe proporcionar toda la carga útil del panel de control, incluidos los datos de la instantánea. Este punto final está diseñado para la interfaz de usuario de Grafana.

Ejemplo de respuesta

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

Claves:

  • DeleteKey: clave generada para usarse para eliminar la instantánea.

  • clave: clave generada para compartir el panel de control.

Obtenga una lista de instantáneas

GET /api/dashboard/snapshots

Parámetros de consulta:

  • consulta: consulta de búsqueda

  • límite: limita el número de resultados devueltos

Ejemplo de solicitud

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

Ejemplo de respuesta

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

Obtenga una instantánea por clave

GET /api/snapshots/:key

Ejemplo de solicitud

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

Ejemplo de respuesta

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

Elimine la instantánea por clave

DELETE /api/snapshots/:key

Ejemplo de solicitud

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

Ejemplo de respuesta

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}

Eliminar instantánea mediante DeleteKey

Esta llamada a la API se puede usar sin autenticación mediante la clave de eliminación secreta de la instantánea.

GET /api/snapshots-delete/:deleteKey

Ejemplo de solicitud

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

Ejemplo de respuesta

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}