Folder API

Gunakan Folder API untuk bekerja dengan folder di ruang kerja Grafana Amazon Managed.

Identifier (id) folder adalah nilai numerik auto-incrementing dan hanya unik per ruang kerja. Pengenal unik (uid) folder dapat digunakan untuk mengidentifikasi folder di antara beberapa ruang kerja secara unik. Ini dibuat secara otomatis jika Anda tidak menyediakannya saat Anda membuat folder. Uid memungkinkan memiliki URL yang konsisten untuk mengakses folder dan saat menyinkronkan folder antara beberapa ruang kerja Grafana yang Dikelola Amazon. Penggunaan uid berarti bahwa mengubah judul folder tidak merusak tautan yang ditandai ke folder itu.

Uid dapat memiliki panjang maksimal 40 karakter.

Folder tidak dapat disarangkan.

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.

Folder Umum, dengan id 0, bukan bagian dari API Folder. Anda tidak dapat menggunakan Folder API untuk mengambil informasi tentang folder umum.

Buat folder

POST /api/folders

Membuat folder baru.

Permintaan contoh

POST /api/folders HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
  "uid": "nErXDvCkzz",
  "title": "Department ABC"
}

Skema tubuh JSON:

• uid - Pengidentifikasi unik opsional. Jika null, uid baru dihasilkan.

• judul — Judul untuk folder.

Contoh respon

HTTP/1.1 200
Content-Type: application/json

{
  "id":1,
  "uid": "nErXDvCkzz",
  "title": "Department ABC",
  "url": "/dashboards/f/nErXDvCkzz/department-abc",
  "hasAcl": false,
  "canSave": true,
  "canEdit": true,
  "canAdmin": true,
  "createdBy": "admin",
  "created": "2018-01-31T17:43:12+01:00",
  "updatedBy": "admin",
  "updated": "2018-01-31T17:43:12+01:00",
  "version": 1
}

Kode Status:

• 200 - Dibuat

• 400 - Kesalahan seperti JSON tidak valid, bidang tidak valid atau hilang

• 401 - Tidak Sah

• 403 — Akses ditolak

Perbarui folder

PUT /api/folders/:uid

Memperbarui folder yang ada yang cocok dengan uid.

Permintaan contoh

PUT /api/folders/nErXDvCkzz HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
  "title":"Department DEF",
  "version": 1
}

Skema tubuh JSON:

• uid — Mengubah pengenal unik, jika disediakan.

• judul — Judul folder.

• versi - Berikan versi saat ini untuk dapat menimpa folder. Tidak diperlukan jikaoverwrite=true.

• overwrite — Setel true untuk menimpa folder yang ada dengan versi yang lebih baru.

Contoh respon

HTTP/1.1 200
Content-Type: application/json

{
  "id":1,
  "uid": "nErXDvCkzz",
  "title": "Department DEF",
  "url": "/dashboards/f/nErXDvCkzz/department-def",
  "hasAcl": false,
  "canSave": true,
  "canEdit": true,
  "canAdmin": true,
  "createdBy": "admin",
  "created": "2018-01-31T17:43:12+01:00",
  "updatedBy": "admin",
  "updated": "2018-01-31T17:43:12+01:00",
  "version": 1
}

Kode Status:

• 200 - Dibuat

• 400 - Kesalahan seperti JSON tidak valid, bidang tidak valid atau hilang

• 401 - Tidak Sah

• 403 — Akses ditolak

• 404 - Folder tidak ditemukan

• 412 — Prasyarat gagal

Kode status 412 digunakan untuk menjelaskan mengapa folder tidak dapat diperbarui.

• Folder telah diubah oleh orang lain status=version-mismatch

Badan respons memiliki sifat-sifat berikut:

HTTP/1.1 412 Precondition Failed
Content-Type: application/json; charset=UTF-8
Content-Length: 97

{
  "message": "The folder has been changed by someone else",
  "status": "version-mismatch"
}

Dapatkan semua folder

GET /api/folders

Mengembalikan semua folder yang Anda memiliki izin untuk melihat. Anda dapat mengontrol jumlah maksimum folder yang dikembalikan dengan menggunakan parameter limit kueri. Defaultnya adalah 1000.

Permintaan contoh

GET /api/folders?limit=10 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Contoh respon

HTTP/1.1 200
Content-Type: application/json

[
  {
    "id":1,
    "uid": "nErXDvCkzz",
    "title": "Department ABC"
  },
  {
    "id":2,
    "uid": "k3S1cklGk",
    "title": "Department RND"
  }
]

Dapatkan folder dengan uid

GET /api/folders/:uid

Mengembalikan semua folder yang cocok dengan uid yang diberikan.

Permintaan contoh

GET /api/folders/nErXDvCkzzh HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Contoh respon

HTTP/1.1 200
Content-Type: application/json

{
  "id":1,
  "uid": "nErXDvCkzz",
  "title": "Department ABC",
  "url": "/dashboards/f/nErXDvCkzz/department-abc",
  "hasAcl": false,
  "canSave": true,
  "canEdit": true,
  "canAdmin": true,
  "createdBy": "admin",
  "created": "2018-01-31T17:43:12+01:00",
  "updatedBy": "admin",
  "updated": "2018-01-31T17:43:12+01:00",
  "version": 1
}

Kode Status:

• 200 — Ditemukan

• 401 - Tidak Sah

• 403 — Akses ditolak

• 404 - Tidak ditemukan

Dapatkan folder dengan id

GET /api/folders/id/:id

Mengembalikan folder yang cocok dengan id yang diberikan.

Permintaan contoh

GET /api/folders/id/1 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Contoh respon

HTTP/1.1 200
Content-Type: application/json

{
  "id":1,
  "uid": "nErXDvCkzz",
  "title": "Department ABC",
  "url": "/dashboards/f/nErXDvCkzz/department-abc",
  "hasAcl": false,
  "canSave": true,
  "canEdit": true,
  "canAdmin": true,
  "createdBy": "admin",
  "created": "2018-01-31T17:43:12+01:00",
  "updatedBy": "admin",
  "updated": "2018-01-31T17:43:12+01:00",
  "version": 1
}

Kode Status:

• 200 — Ditemukan

• 401 - Tidak Sah

• 403 — Akses ditolak

• 404 - Tidak ditemukan

Hapus folder dengan uid

DELETE /api/folders/:uid

Menghapus folder yang cocok dengan uid, dan juga menghapus semua dasbor yang disimpan di folder. Eprasi ini tidak dapat dikembalikan.

Permintaan contoh

DELETE /api/folders/nErXDvCkzz HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Contoh respon

HTTP/1.1 200
Content-Type: application/json

{
  "message":"Folder deleted",
  "id": 2
}

Kode Status:

• 200 - Dihapus

• 401 - Tidak Sah

• 403 — Akses ditolak

• 404 - Tidak ditemukan