Gunakan kunci API untuk mengautentikasi dengan Grafana HTTP API - Amazon Managed Grafana
Membuat kunci API ruang kerja (Konsol)Membuat kunci API ruang kerja ()AWS CLI

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Gunakan kunci API untuk mengautentikasi dengan Grafana HTTP API

Salah satu cara untuk mengakses API Grafana adalah dengan menggunakan kunci API, yang juga disebut token API. Untuk membuat kunci API, gunakan salah satu prosedur berikut. Kunci API valid untuk waktu terbatas yang Anda tentukan saat Anda membuatnya, hingga 30 hari.

catatan

Di versi 9 atau yang lebih baru, lebih disukai menggunakan akun layanan alih-alih kunci API. Akun layanan mengganti kunci API sebagai cara utama untuk mengautentikasi aplikasi yang berinteraksi dengan API Grafana. Grafana Labs telah mengumumkan bahwa kunci API akan dihapus dalam rilis mendatang.

Saat membuat kunci API, Anda menentukan peran untuk kunci tersebut. Peran menentukan tingkat kekuatan administratif yang dimiliki pengguna kunci.

Tabel berikut menunjukkan izin yang diberikan ke peran Admin, Editor, dan Penampil. Tabel pertama menunjukkan izin organisasi umum. Dalam tabel ini, Penuh berarti kemampuan untuk melihat, mengedit, menambahkan izin, dan menghapus izin. Kolom Jelajahi menunjukkan apakah peran dapat menggunakan tampilan Jelajahi. Kolom Izin lainnya menunjukkan apakah peran memiliki izin untuk mengelola pengguna, tim, plug-in, dan pengaturan organisasi.

Peran Dasbor Daftar Putar Folder Jelajahi Sumber data Izin lainnya

Penampil

 Tayang Tayang Tidak Tidak Tidak Tidak

Penyunting

 Penuh Penuh Penuh Ya Tidak Tidak

Admin

 Penuh Penuh Penuh Ya Penuh Penuh

Tabel berikut menunjukkan izin dasbor dan tingkat folder tambahan yang dapat Anda atur. Ini berbeda dari peran Admin, Editor, dan Penampil.

Peran Dasbor Folder Ubah izin

Lihat

 Tayang Tayang Tidak

Sunting

 Buat, edit Tayang Tidak

Admin

 Buat, edit, hapus Buat, edit, hapus Ya
catatan

Izin yang lebih terbatas dengan tingkat izin yang lebih rendah tidak berpengaruh jika aturan yang lebih umum dengan izin lebih banyak ada. Misalnya, jika Anda memberi pengguna peran Editor organisasi dan kemudian menetapkan pengguna itu hanya izin Tampilan untuk dasbor, izin Tampilan yang lebih ketat tidak berpengaruh karena pengguna memiliki akses Edit penuh karena peran Editor mereka.

Membuat kunci API Grafana untuk digunakan dengan Grafana API di ruang kerja (Konsol)

catatan

Di ruang kerja Grafana Terkelola Amazon yang kompatibel dengan Grafana versi 10 ke atas, kemampuan untuk membuat kunci API di ruang kerja telah dihapus. Jika ruang kerja Anda adalah ruang kerja Grafana versi 10, Anda hanya dapat membuat kunci API melalui AWS CLI atau API.

Penghapusan kunci API telah diumumkan oleh Grafana Labs untuk rilis di masa mendatang. Disarankan agar Anda menggunakan akun layanan sebagai gantinya.

Untuk membuat kunci API Grafana untuk digunakan dengan Grafana API di konsol ruang kerja

  1. Buka konsol Grafana Terkelola Amazon di https://console.aws.amazon.com/grafana/.

  2. Di sudut kiri atas halaman, pilih ikon menu dan kemudian pilih Semua ruang kerja.

  3. Pilih nama ruang kerja Grafana yang Dikelola Amazon.

  4. Di halaman detail ruang kerja, pilih URL yang ditampilkan di bawah URL ruang kerja Grafana.

  5. Di menu sisi konsol Grafana, jeda ikon Konfigurasi (roda gigi), lalu pilih Kunci API.

  6. Pilih Kunci API Baru.

  7. Masukkan nama unik untuk kunci tersebut.

  8. Untuk Peran, pilih tingkat akses yang kuncinya akan diberikan. Pilih Admin untuk mengizinkan pengguna dengan kunci ini menggunakan API di tingkat administratif terluas dan paling kuat. Pilih Editor atau Penampil untuk membatasi pengguna kunci ke tingkat daya tersebut. Untuk informasi selengkapnya, lihat tabel sebelumnya.

  9. Agar Waktu hidup, tentukan berapa lama Anda ingin kunci tersebut valid. Maksimal adalah 30 hari (satu bulan). Anda memasukkan nomor dan surat. Huruf yang valid adalah s untuk detik, m untuk menit, h untuk jam, d untuk hari, w selama berminggu-minggu, dan M untuk bulan. Misalnya, 12 jam adalah 12 jam dan 1M adalah 1 bulan (30 hari).

    Kami sangat menyarankan Anda mengatur waktu kunci untuk hidup untuk waktu yang lebih singkat, seperti beberapa jam atau kurang. Ini menciptakan risiko yang jauh lebih kecil daripada memiliki kunci API yang valid untuk waktu yang lama.

  10. Pilih Tambahkan.

  11. (Opsional) Anda dapat mengotomatiskan pembuatan kunci API dengan Create API Key API menggunakan Terraform. Untuk informasi selengkapnya tentang mengotomatiskan pembuatan kunci API menggunakan Terraform, lihat Membuat Kunci API Grafana menggunakan Terraform.

Membuat kunci API ruang kerja Grafana yang Dikelola Amazon menggunakan AWS CLI

Untuk membuat kunci API ruang kerja Grafana Amazon Managed menggunakan AWS CLI

Dalam contoh berikut, ganti key_name, key_role, seconds_to_live dan workspace_id dengan informasi Anda sendiri. Untuk mengetahui tentang format nama kunci, peran kunci, dan seconds-to-live, lihat https://docs.aws.amazon.com/grafana/latest/APIReference/API_CreateWorkspaceApiKey.html di panduan API. 

aws grafana create-workspace-api-key --key-name "key_name" --key-role "key_role" --seconds-to-live seconds_to_live --workspace-id "workspace_id"

Berikut ini adalah contoh respons CLI:

create-workspace-api-key contoh keluaran

Anda dapat menemukan workspace_id ruang kerja Anda dengan menjalankan perintah berikut:

aws grafana list-workspaces