本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
快照集 API
使用快照 API 在 Amazon 受管的 Grafana 工作區中處理快照。
注意
若要將 Grafana API 與您的 Amazon 受管理工作區搭配使用,您必須擁有有效的 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 }
主體結構定義:
-
儀表板-(必填)完整的儀表板模型。
-
name — (選擇性) 快照的名稱。
-
expires — (選用) 快照到期的時間 (以秒為單位)。預設值為永不過期。
-
external — (選擇性) 將快照儲存在外部伺服器上,而不是在本機上儲存。預設為 false。
-
key — (如果
external
是,則為必要true
) 定義唯一金鑰。 -
刪除金鑰 — (如果
external
是,則為必要true
) 用來刪除快照的唯一金鑰。與僅建立者可以刪除快照不同。key
注意
使用 API 建立快照時,您必須提供包括快照資料在內的完整儀表板承載。此端點是專為 Grafana 使用者介面而設計的。
回應範例
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
查詢參數:
-
查詢-搜索查詢
-
限制-限制返回結果的數量
範例請求
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}