スナップショット API

スナップショット API を使用して、Amazon Managed Grafana ワークスペースのスナップショットを操作します。

注記

Amazon Managed 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 本文スキーマ：

• ダッシュボード — (必須) ダッシュボードモデル全体。

• name — (オプション) スナップショットの名前。

• expires — (オプション) スナップショットの有効期限が切れるタイミングを秒単位で表します。デフォルトでは、有効期限はありません。

• external — (オプション) スナップショットをローカルではなく外部サーバーに保存します。デフォルトは false です。

• key — ( externalが の場合に必須true) 一意のキーを定義します。

• deletekey — ( externalが の場合に必須true) スナップショットの削除に使用する一意のキー。作成者だけがスナップショットを削除できるように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 — スナップショットの削除に使用されるために生成されたキー。

• key — ダッシュボードを共有するために生成されたキー。

スナップショットのリストを取得する

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}