Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
API Anotasi
Gunakan API Anotasi untuk membuat, memperbarui, menghapus, dan bekerja dengan anotasi di ruang kerja Grafana Terkelola Amazon.
Anotasi disimpan dalam database Grafana ruang kerja (sqlite, mysql atau postgres). Anotasi dapat berupa anotasi global yang dapat ditampilkan di dasbor apa pun dengan mengonfigurasi sumber data anotasi. Anotasi disaring oleh tag. Atau mereka dapat diikat ke panel di dasbor, dan hanya ditampilkan pada panel itu.
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.
Temukan anotasi
GET /api/annotations?from=1506676478816&to=1507281278816&tags=tag1&tags=tag2&limit=100
Permintaan contoh
GET /api/annotations?from=1506676478816&to=1507281278816&tags=tag1&tags=tag2&limit=100 HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
Parameter kueri:
-
dari - (Opsional) Epoch datetime dalam milidetik.
-
ke - (Opsional) Epoch datetime dalam milidetik.
-
limit - (Opsional) Jumlah maksimum hasil yang dikembalikan. Secara default, nilainya adalah 100.
-
alertid - (Opsional) FInd anotasi untuk peringatan yang ditentukan.
-
DashboardID - (Opsional) Temukan anotasi yang dicakup ke dasbor yang ditentukan.
-
PaneLid - (Opsional) Temukan anotasi yang dicakup ke panel yang ditentukan.
-
UserID - (Opsional) Temukan anotasi yang dibuat oleh pengguna yang ditentukan.
-
type β (Opsional) Tentukan untuk mengembalikan peringatan atau anotasi yang dibuat pengguna. Nilai nilai adalah
alert
danannotation
. -
tag β (Opsional) Gunakan ini untuk memfilter anotasi global. Anotasi global adalah anotasi dari sumber data anotasi yang tidak terhubung secara khusus ke dasbor atau panel. Untuk melakukan pemfilteran βANDβ dengan beberapa tag, tentukan parameter tag beberapa kali. Misalnya,
tags=tag1&tags=tag2
. Ini adalah tag Grafana, bukan AWS tag.
Contoh respon
HTTP/1.1 200 Content-Type: application/json [ { "id": 1124, "alertId": 0, "dashboardId": 468, "panelId": 2, "userId": 1, "userName": "", "newState": "", "prevState": "", "time": 1507266395000, "timeEnd": 1507266395000, "text": "test", "metric": "", "tags": [ "tag1", "tag2" ], "data": {} }, { "id": 1123, "alertId": 0, "dashboardId": 468, "panelId": 2, "userId": 1, "userName": "", "newState": "", "prevState": "", "time": 1507265111000, "text": "test", "metric": "", "tags": [ "tag1", "tag2" ], "data": {} } ]
Buat anotasi
POST /api/annotations
Membuat anotasi dalam database Grafana ruang kerja. panelId
Bidang dashboardId
dan adalah opsional. Jika tidak ditentukan, anotasi global akan dibuat dan dapat ditanyakan di dasbor mana pun yang menambahkan sumber data anotasi Grafana. Saat membuat anotasi wilayah, pastikan untuk menyertakan timeEnd
properti.
Format untuk time
dan timeEnd
harus berupa angka epoch dalam resolusi milidetik.
Permintaan contoh
POST /api/annotations HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk { "dashboardId":468, "panelId":1, "time":1507037197339, "timeEnd":1507180805056, "tags":["tag1","tag2"], "text":"Annotation Description" }
Contoh respon
HTTP/1.1 200 Content-Type: application/json { "message":"Annotation added", "id": 1, }
Buat anotasi dalam format grafit
POST /api/annotations/graphite
Membuat anotasi dengan menggunakan format acara yang kompatibel dengan Graphite. data
Bidang when
dan adalah opsional. Jika tidak when
ditentukan, waktu saat ini digunakan sebagai stempel waktu anotasi. tags
Bidang ini juga bisa dalam sebelum format Graphite 0.10.0 (string dengan beberapa tag dipisahkan oleh spasi).
Permintaan contoh
POST /api/annotations/graphite HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk { "what": "Event - deploy", "tags": ["deploy", "production"], "when": 1467844481, "data": "deploy of master branch happened at Wed Jul 6 22:34:41 UTC 2016" }
Contoh respon
HTTP/1.1 200 Content-Type: application/json { "message":"Graphite annotation added", "id": 1 }
Perbarui anotasi
PUT /api/annotations/:id
pdates semua properti dari anotasi yang cocok dengan id yang ditentukan. Untuk hanya memperbarui properti tertentu, gunakan operasi Patch Annotation.
Permintaan contoh
PUT /api/annotations/1141 HTTP/1.1 Accept: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk Content-Type: application/json { "time":1507037197339, "timeEnd":1507180805056, "text":"Annotation Description", "tags":["tag3","tag4","tag5"] }
Contoh respon:
HTTP/1.1 200 Content-Type: application/json { "message":"Annotation updated" }
Anotasi tambalan
PATCH /api/annotations/:id
Memperbarui satu atau beberapa properti anotasi yang cocok dengan id yang ditentukan. Operasi ini saat ini mendukung pembaruantext
,tags
,time
, dan timeEnd
properti.
Permintaan contoh:
PATCH /api/annotations/1145 HTTP/1.1 Accept: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk Content-Type: application/json { "text":"New Annotation Description", "tags":["tag6","tag7","tag8"] }
Contoh respon
HTTP/1.1 200 Content-Type: application/json { "message":"Annotation patched" }
Hapus anotasi oleh Id
DELETE /api/annotations/:id
Menghapus anotasi yang cocok dengan Id yang ditentukan.
Permintaan contoh
DELETE /api/annotations/1 HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
Contoh respon
HTTP/1.1 200 Content-Type: application/json { "message":"Annotation deleted" }