스냅샷 API

스냅샷 API를 사용하여 Amazon 관리형 Grafana 워크스페이스에서 스냅샷을 작업할 수 있습니다.

참고

아마존 관리형 그라파나 워크스페이스에서 Grafana API를 사용하려면 유효한 Grafana API 토큰이 있어야 합니다. API 요청의 필드에 이를 포함시키세요. Authorization API 호출을 인증하기 위한 토큰을 생성하는 방법에 대한 자세한 내용은 을 참조하십시오토큰으로 인증.

새 스냅샷 생성

POST /api/snapshots

요청 예제

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 본문 스키마:

• 대시보드 — (필수) 전체 대시보드 모델.

• 이름 — (선택 사항) 스냅샷의 이름.

• 만료 — (선택 사항) 스냅샷이 만료되는 시기 (초 단위). 기본값은 만료되지 않는 것입니다.

• external - (선택 사항) 스냅샷을 로컬이 아닌 외부 서버에 저장합니다. 기본값은 false입니다.

• key - (있는 external 경우 필수true) 고유 키를 정의합니다.

• deletekey - (있는 경우 필수true) 스냅샷을 삭제하는 데 사용되는 고유 external 키입니다. 생성자만 스냅샷을 삭제할 key 수 있다는 점이 다릅니다.

참고

API를 사용하여 스냅샷을 생성할 때는 스냅샷 데이터를 포함한 전체 대시보드 페이로드를 제공해야 합니다. 이 엔드포인트는 Grafana UI용으로 설계되었습니다.

응답의 예

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

키:

• DeleteKey — 스냅샷을 삭제하는 데 사용하기 위해 생성된 키입니다.

• 키 - 대시보드를 공유하기 위해 생성된 키입니다.

스냅샷 목록 가져오기

GET /api/dashboard/snapshots

쿼리 매개변수:

• 쿼리 — 검색 쿼리

• limit — 반환되는 결과 수를 제한합니다.

요청 예제

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

응답의 예

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

키로 스냅샷 가져오기

GET /api/snapshots/:key

요청 예제

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

응답의 예

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

키별로 스냅샷 삭제

DELETE /api/snapshots/:key

요청 예제

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

응답의 예

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}

DeleteKey를 사용하여 스냅샷을 삭제합니다.

스냅샷의 비밀 삭제 키를 사용하여 인증 없이 이 API 호출을 사용할 수 있습니다.

GET /api/snapshots-delete/:deleteKey

요청 예제

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

응답의 예

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}