API de instantâneos

Use a API Snapshot para trabalhar com snapshots em um espaço de trabalho do Amazon Managed Grafana.

nota

Para usar uma API do Grafana com seu espaço de trabalho do Amazon Managed Grafana, você deve ter um token válido da API Grafana. Você inclui isso no Authorization campo na solicitação da API. Para obter informações sobre como criar um token para autenticar suas chamadas de API, consulteAutenticar com tokens.

Crie uma nova captura de imagem

POST /api/snapshots

Exemplo de solicitação

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 JSON:

• painel — (Obrigatório) O modelo completo do painel.

• name — (Opcional) Um nome para o instantâneo.

• expira — (Opcional) Quando o instantâneo deve expirar, em segundos. O padrão é nunca expirar.

• externo — (Opcional) Salve o instantâneo em um servidor externo em vez de localmente. O padrão é falso.

• chave — (Obrigatório se external fortrue) Defina uma chave exclusiva.

• deletekey — (Obrigatório se external fortrue) Uma chave exclusiva a ser usada para excluir o instantâneo. É diferente do key fato de que somente o criador possa excluir o instantâneo.

nota

Ao criar um instantâneo usando a API, você precisa fornecer a carga útil completa do painel, incluindo os dados do instantâneo. Esse endpoint foi projetado para a interface do usuário do Grafana.

Exemplo de resposta

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

Chaves:

• DeleteKey — Uma chave gerada para ser usada para excluir o snapshot.

• key — Uma chave gerada para compartilhar o painel.

Obtenha uma lista de instantâneos

GET /api/dashboard/snapshots

Parâmetros de consulta:

• query — Consulta de pesquisa

• limite — Limita o número de resultados retornados

Exemplo de solicitação

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

Exemplo de resposta

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

Obtenha um instantâneo por chave

GET /api/snapshots/:key

Exemplo de solicitação

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

Exemplo de resposta

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

Excluir instantâneo por chave

DELETE /api/snapshots/:key

Exemplo de solicitação

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

Exemplo de resposta

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}

Excluir instantâneo por DeleteKey

Essa chamada de API pode ser usada sem autenticação usando a chave secreta de exclusão para o snapshot.

GET /api/snapshots-delete/:deleteKey

Exemplo de solicitação

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

Exemplo de resposta

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}