Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Snapshot API
Gunakan Snapshot API untuk bekerja dengan snapshot di ruang kerja Grafana yang Dikelola Amazon.
catatan
Untuk menggunakan Grafana API dengan ruang kerja Grafana Amazon Managed, Anda harus memiliki token Grafana API yang valid. Anda menyertakan ini di Authorization
bidang dalam permintaan API. Untuk informasi tentang cara membuat token untuk mengautentikasi panggilan API Anda, lihatOtentikasi dengan token.
Buat shapshot baru
POST /api/snapshots
Contoh permintaan
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 }
Skema tubuh JSON:
-
dashboard — (Wajib) Model dasbor lengkap.
-
name — (Opsional) Nama untuk snapshot.
-
kedaluwarsa — (Opsional) Ketika snapshot akan kedaluwarsa, dalam hitungan detik. Defaultnya adalah tidak pernah kedaluwarsa.
-
eksternal — (Opsional) Simpan snapshot di server eksternal daripada secara lokal. Default adalah false.
-
key — (Diperlukan jika
external
adatrue
) Tentukan kunci unik. -
deletekey — (Diperlukan jika
external
adatrue
) Kunci unik yang akan digunakan untuk menghapus snapshot. Ini berbeda darikey
sehingga hanya pencipta yang dapat menghapus snapshot.
catatan
Saat membuat snapshot menggunakan API, Anda harus memberikan payload dasbor lengkap termasuk data snapshot. Titik akhir ini dirancang untuk UI Grafana.
Contoh respon
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, }
Kunci:
-
DeleteKey — Kunci yang dihasilkan untuk digunakan untuk menghapus snapshot.
-
kunci — Kunci yang dihasilkan untuk berbagi dasbor.
Dapatkan daftar snapshot
GET /api/dashboard/snapshots
Parameter kueri:
-
query — Permintaan pencarian
-
limit — Batasi jumlah hasil yang dikembalikan
Contoh permintaan
GET /api/dashboard/snapshots HTTP/1.1 Accept: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
Contoh respon
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" } ]
Dapatkan snapshot dengan kunci
GET /api/snapshots/:key
Contoh permintaan
GET /api/snapshots/YYYYYYY HTTP/1.1 Accept: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
Contoh respon
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 } }
Hapus snapshot dengan kunci
DELETE /api/snapshots/:key
Contoh permintaan
DELETE /api/snapshots/YYYYYYY HTTP/1.1 Accept: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
Contoh respon
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}
Hapus snapshot dengan DeleteKey
Panggilan API ini dapat digunakan tanpa otentikasi dengan menggunakan kunci hapus rahasia untuk snapshot.
GET /api/snapshots-delete/:deleteKey
Contoh permintaan
GET /api/snapshots-delete/XXXXXXX HTTP/1.1 Accept: application/json
Contoh respon
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}