Menggunakan API Monitoring Management API

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Gunakan API pengelolaan Pemantauan API untuk melakukan tugas berikut.

Tugas Informasi Selengkapnya
Mengelola pemberitahuan untuk Pemantauan API
Mengelola koleksi untuk Pemantauan API
Melihat log Monitoring API di berbagai tingkat
Melihat metrik Monitoring API

Kuota panggilan API

Semua API Monitoring API menerapkan kuota yang membatasi frekuensi Anda dapat memanggil API per menit. Misalnya, API Create collections membatasi Anda untuk melakukan enam panggilan per menit.

Tidak semua API memiliki batas kuota yang sama. Lihat dokumentasi referensi API di setiap API untuk menentukan batasnya.

Menggunakan curl

Contoh API dalam dokumen ini menggunakan curl untuk menunjukkan cara menggunakan Pemantauan API menggunakan API. curl adalah alat command line open source untuk mentransfer data dengan sintaksis URL, yang mendukung protokol umum seperti HTTP dan HTTPS. Untuk informasi tentang cara mendownload dan menggunakan curl, lihat https://curl.haxx.se/.

Tabel berikut meringkas opsi command line curl yang digunakan dalam contoh.

Opsi Deskripsi
-d '{}'

--data @filename

Menentukan isi permintaan, yang diteruskan secara langsung atau dengan menentukan nama file.
-H

--header

Menentukan header permintaan. Anda harus meneruskan informasi berikut di header permintaan:
  • Token OAuth 2.0 untuk autentikasi pengguna menggunakan header Authorization, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0.
  • Jenis konten yang didukung oleh klien menggunakan header Accept.
  • Jenis konten isi permintaan yang dikirim saat membuat atau memperbarui resource (POST, PATCH, PUT) menggunakan header Content-Type.
-i Menampilkan informasi selengkapnya, seperti header, dalam respons.
-X Menentukan jenis permintaan (GET, POST, dan sebagainya).

Mendapatkan token akses OAuth 2.0

Apigee Edge mendukung OAuth 2.0 untuk autentikasi pengguna. Dengan OAuth 2.0, Anda menukar kredensial Apigee Edge dengan token akses dan token refresh yang kemudian dapat Anda gunakan untuk melakukan panggilan aman ke Apigee Edge API. Setelah mendapatkan token, Anda tidak perlu menukar kredensial lagi hingga masa berlaku token berakhir. Token refresh memungkinkan Anda mempertahankan "sesi" dengan server selama jangka waktu yang lebih lama tanpa memberikan kredensial Anda. Untuk informasi selengkapnya tentang token akses, lihat Menggunakan OAuth2 untuk mengakses API pengelolaan.

Dengan menggunakan kredensial Apigee Edge, Anda bisa mendapatkan token akses dan token refresh OAuth 2.0 untuk mengakses resource Apigee Edge menggunakan utilitas get_token Apigee.

Untuk mendapatkan token akses OAuth 2.0:

  1. Instal utilitas get_token. Untuk informasi tentang cara menginstal utilitas get_token, lihat Menggunakan get_token.

  2. Jalankan get_token untuk mendapatkan token akses OAuth 2.0.

    Saat pertama kali Anda memasukkan perintah atau jika masa berlaku token refresh telah habis, get_token akan meminta nama pengguna, sandi, dan kode autentikasi 2 langkah enam digit. Masukkan setiap nilai saat diminta. Jika Anda tidak mengaktifkan autentikasi 2 langkah, cukup tekan Enter saat diminta.

  3. Salin token OAuth 2.0 dan simpan dalam variabel, seperti ACCESS_TOKEN: 

    export ACCESS_TOKEN=eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOiI2NmQ4MTRiMC01YzZkLTQyZWUtYjlmYi05ZGVhODk5MGRiODIiLCJzdWIiOiJlZjc3YmRhMS05ZWIxLTQyZDgtODg5MC0zODQ3ODg0MzM1OWIiLCJzY29wZSI6WyJzY2ltLmVtYWlscy5yZWFkIiwicGFzc3dvcmQud3JpdGUiLCJhcHByb3ZhbHMubWUiLCJzY2ltLm1lIiwic2NpbS5pZHMucmVhZCIsIm9wZW5pZCIsIm9hdXRoLmFwcHJvdmFscyJdLCJjbGllbnRfaWQiOiJlZGdlY2xpIiwiY2lkIjoiZWRnZWNsaSIsImF6cCI6ImVkZ2VjbGkiLCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJ1c2VyX2lkIjoiZWY3N2JkYTEtOWViMS00MmQ4LTg4OTAtMzg0Nzg4NDMzNTliIiwib3JpZ2luIjoidXNlcmdyaWQiLCJ1c2VyX25hbWUiOiJsbHluY2hAYXBpZ2VlLmNvbSIsImVtYWlsIjoibGx5bmNoQGFwaWdlZS5jb20iLCJyZXZfc2lnIjoiZTViZDc3NjIiLCJpYXQiOjE0NzA3NTMyMDksImV4cCI6MTQ3MDc5NjQwOSwiaXNzIjoiaHR0cHM6Ly9sb2dpbi5lMmUuYXBpZ2VlLm5ldC9vYXV0aC90b2tlbiIsInppZCI6InVhYSIsImF1ZCI6WyJzY2ltIiwicGFzc3dvcmQiLCJvcGVuaWQiLCJlZGdlY2xpIiwiYXBwcm92YWxzIiwic2NpbS5lbWFpbHMiLCJzY2ltLmlkcyIsIm9hdXRoIl19.FF3f1i9eHbBqYjnvBmt9nTtTcyNQBQRDDq2tQ3aRUAzUesLAet7qfBB9QVCvE-zVBn4BiPgRU-iturxPxRMAQ2a34-8oLvgff3x-aALBWkSwbc8PJdWTiPP9VYykoFSJtu9UIN5x0FQEQN_hyurO8D2SrS3uQKNwIyjoJPy4Bps7nb3WqJyKRfXAzf8UptdN7XE0TVqTyBcZGT3OQ2Was0VPfe_dr-wIrywvjNf6FczjdktB1lpKJ2oRXx1n8PuK5FhOQ4wE9VeSsNsMHVcGvJ5W6Tvi61fo2h1w1d4AKvGdERzuVf_XWN00mtcgwsUAuXV0r5H_i3vxcMuUym1XOg

Saat Anda memanggil API Monitoring API, teruskan token akses OAuth 2.0 di header HTTP menggunakan header Authorization. Contoh:


curl -X GET "https://apimonitoring.enterprise.apigee.com/alerts?org=myorg"
   -H "Authorization: Bearer $ACCESS_TOKEN" 
   ...