Mengelola add-on Analytics Apigee API

Halaman ini berlaku untuk Apigee, tetapi tidak untuk Apigee Hybrid.

Lihat dokumentasi Apigee Edge.

Apigee API Analytics mengumpulkan dan menghitung banyak informasi yang mengalir melalui proxy API. Anda dapat memvisualisasikan data ini dengan grafik dan diagram di UI Apigee, atau Anda dapat mendownload data mentah untuk analisis offline menggunakan Apigee API. Untuk mengetahui informasi selengkapnya tentang jenis data yang dapat Anda kumpulkan dan analisis dengan Apigee API Analytics, lihat Ringkasan Analytics Apigee.

Jika Anda adalah pelanggan Apigee dengan model Bayar sesuai penggunaan, Analisis API Apigee tersedia sebagai add-on berbayar. Topik ini menjelaskan cara mengaktifkan dan mengelola add-on Analisis API Apigee untuk lingkungan Pay-as-you-go yang memenuhi syarat. Untuk mengetahui informasi selengkapnya tentang cara menggunakan dasbor Analytics API Apigee setelah add-on diaktifkan di lingkungan Apigee, lihat Menggunakan dasbor analisis.

Ketersediaan

Analytics API Apigee tersedia sebagai kemampuan add-on berbayar yang dikelola untuk setiap lingkungan Apigee dalam penerapan Apigee Anda. Add-on dapat diaktifkan di lingkungan Menengah atau Komprehensif Apigee. Anda tidak dapat mengaktifkan dan menggunakan Apigee API Analytics di lingkungan Base. Untuk mengetahui detail selengkapnya tentang kemampuan lingkungan Apigee, lihat Perbandingan jenis lingkungan.

Peran dan izin yang diperlukan

Untuk mendapatkan izin yang diperlukan untuk mengelola add-on Analisis API Apigee, minta administrator Anda untuk memberi Anda peran IAM Administrator Lingkungan Apigee (apigee.environment.admin) di project. Untuk mengetahui informasi selengkapnya tentang cara memberikan peran, lihat Mengelola akses ke project, folder, dan organisasi.

Peran bawaan ini berisi izin yang diperlukan untuk mengelola add-on Apigee API Analytics. Untuk melihat izin yang benar-benar diperlukan, luaskan bagian Izin yang diperlukan:

Izin yang diperlukan

Izin berikut diperlukan untuk mengelola add-on Apigee API Analytics:

  • apigee.addonsconfig.get
  • apigee.addonsconfig.update

Anda mungkin juga bisa mendapatkan izin ini dengan peran khusus atau peran bawaan lainnya.

Mengaktifkan add-on Analisis API Apigee

Anda dapat mengaktifkan add-on Apigee API Analytics untuk lingkungan Apigee Menengah atau Komprehensif menggunakan UI Apigee di konsol Google Cloud atau menggunakan API, seperti yang dijelaskan di bagian berikut.

Apigee di Google Cloud console

Untuk mengaktifkan add-on Apigee API Analytics di konsol Google Cloud :

  1. Buka halaman Apigee di konsol.

    Buka Apigee

  2. Pilih project dengan organisasi dan lingkungan Pay-as-you-go yang ingin Anda kelola.
  3. Pilih Add-on > Analytics untuk membuka halaman Add-on Analytics.
  4. Di panel Manage Apigee API Analytics add-on, centang kotak untuk lingkungan tempat Anda ingin mengaktifkan add-on.
  5. Klik Aktifkan yang dipilih.
  6. Setelah pengaktifan selesai untuk lingkungan yang dipilih, Status lingkungan akan menampilkan Diaktifkan.
  7. Untuk melihat data Analisis Apigee API, pilih Analytics > Metrik API untuk melihat data analisis Anda. Mungkin perlu waktu hingga 10 menit untuk menampilkan data analisis.

Apigee API

Untuk mengaktifkan add-on Apigee API Analytics menggunakan Apigee API, masukkan perintah berikut:

curl -X POST \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig:setAddonEnablement \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json" \
      -d '{"analyticsEnabled":true}'

Dengan:

  • ORG_NAME adalah nama organisasi Apigee dengan model bayar sesuai penggunaan yang ingin Anda tambahi Analytics ke lingkungan yang memenuhi syarat.
  • ENV_NAME adalah nama lingkungan Apigee tempat Anda ingin mengaktifkan add-on Apigee API Analytics.

Setelah pengaktifan selesai, pilih Analytics > Metrik API untuk melihat data Analisis API Apigee Anda. Mungkin perlu waktu hingga 10 menit agar data analisis ditampilkan di UI, atau tersedia melalui panggilan API.

Proses pengaktifan add-on Apigee API Analytics dapat memerlukan waktu hingga 15 menit. Setelah diaktifkan, data analisis untuk lingkungan akan dipertahankan selama 14 bulan. Anda dapat mengakses data historis lingkungan dari halaman Metrik API di konsol selama add-on diaktifkan.

Penagihan untuk penggunaan add-on Apigee API Analytics dimulai setelah pengaktifan add-on dimulai.

Menonaktifkan add-on Analisis API Apigee

Anda dapat menonaktifkan add-on Apigee API Analytics untuk lingkungan Apigee Menengah atau Komprehensif menggunakan UI Apigee di konsol Google Cloud atau menggunakan API, seperti yang dijelaskan di bagian berikut.

Jika add-on Advanced API Security diaktifkan di lingkungan, Anda harus menonaktifkan add-on Advanced API Security sebelum dapat menonaktifkan add-on Apigee API Analytics. Jika add-on Advanced API Security tidak dinonaktifkan, setiap permintaan untuk menonaktifkan Apigee API Analytics di lingkungan akan gagal. Jika add-on Advanced API Security diaktifkan di lingkungan Anda, add-on tersebut akan ditampilkan di kolom Other enabled add-ons di panel Manage Apigee API Analytics add-on.

Untuk menonaktifkan add-on, lihat Menonaktifkan add-on Advanced API Security.

Apigee di Konsol Cloud

Untuk menonaktifkan add-on Apigee API Analytics di konsol Google Cloud :

  1. Buka halaman Apigee di konsol.

    Buka Apigee

  2. Pilih project dengan organisasi dan lingkungan Pay-as-you-go yang ingin Anda kelola.
  3. Pilih Add-on > Analytics untuk membuka halaman Add-on Analytics.
  4. Di panel Manage Apigee API Analytics add-on, centang kotak untuk lingkungan tempat Anda ingin menonaktifkan add-on.
  5. Klik Nonaktifkan yang dipilih.
  6. Setelah penonaktifan selesai, Status akan menampilkan Nonaktif untuk setiap lingkungan.

Apigee API

Untuk menonaktifkan add-on Apigee API Analytics menggunakan Apigee API, masukkan perintah berikut:

curl -X POST \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig:setAddonEnablement \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json" \
      -d '{"analyticsEnabled":false}'

Dengan:

  • ORG_NAME adalah nama organisasi Apigee dengan model bayar sesuai penggunaan yang ingin Anda tambahi Analytics ke lingkungan yang memenuhi syarat.
  • ENV_NAME adalah nama lingkungan Apigee tempat Anda ingin mengaktifkan add-on Apigee API Analytics.

Melihat status add-on Analisis API Apigee di lingkungan

Anda dapat memeriksa status add-on Analisis API Apigee untuk lingkungan Apigee Menengah atau Komprehensif menggunakan UI Apigee di konsol Google Cloud atau menggunakan API, seperti yang dijelaskan di bagian berikut.

Apigee di Google Cloud console

Untuk melihat status add-on Analisis API Apigee di lingkungan menggunakan konsol Google Cloud :

  1. Buka halaman Apigee di konsol.

    Buka Apigee

  2. Pilih project dengan organisasi dan lingkungan Pay-as-you-go yang ingin Anda kelola.
  3. Pilih Add-on > Analytics untuk membuka halaman Add-on Analytics.
  4. Di panel Kelola add-on Apigee API Analytics, daftar lingkungan akan ditampilkan.
  5. Di kolom status, Anda dapat melihat apakah add-on Diaktifkan atau Dinonaktifkan di setiap lingkungan Menengah atau Komprehensif. Lingkungan dasar tidak menampilkan status apa pun.

Apigee API

Untuk melihat status add-on Apigee API Analytics di lingkungan yang menggunakan Apigee API, masukkan perintah berikut:

curl -X GET \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json" 

Dengan:

  • ORG_NAME adalah nama organisasi Apigee dengan model Bayar sesuai penggunaan.
  • ENV_NAME adalah nama lingkungan Apigee.

Respons menampilkan objek analyticsConfig yang merepresentasikan status add-on saat ini.

Mengelola data Analisis API Apigee

Setelah add-on Apigee API Analytics diaktifkan untuk lingkungan, data analisis untuk lingkungan tersebut akan disimpan selama 14 bulan. Anda dapat mengakses data analisis historis lingkungan dari halaman Metrik API di konsol selama add-on diaktifkan.

Jika Anda menonaktifkan add-on Apigee API Analytics di lingkungan, data analisis untuk lingkungan tersebut akan dihapus setelah 30 hari. Jika Anda mengaktifkan kembali add-on di lingkungan yang sama dalam waktu 30 hari setelah penonaktifan, Anda dapat memperoleh kembali akses ke data analisis untuk lingkungan tersebut selama periode retensi 14 bulan. Tidak ada data yang dipulihkan jika add-on diaktifkan kembali untuk lingkungan setelah 30 hari.

Jika Anda ingin menyimpan data analisis untuk lingkungan apa pun di luar periode retensi 14 bulan, sebaiknya ekspor dan simpan data Anda di lokasi lain. Anda juga dapat mengekspor data Analytics sebelum menonaktifkan add-on Apigee API Analytics, atau dalam jangka waktu 30 hari setelah penonaktifan. Untuk mengetahui informasi selengkapnya, lihat Mengekspor data dari Analytics.