Mengelola add-on Analisis Apigee API

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

Lihat Dokumentasi Apigee Edge.

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

Jika Anda adalah pelanggan Apigee Bayar sesuai penggunaan, Analisis API Apigee tersedia sebagai berbayar add-on Anda. Topik ini menjelaskan cara mengaktifkan dan mengelola Analisis API Apigee add-on untuk lingkungan Bayar sesuai penggunaan yang memenuhi syarat. Untuk mengetahui informasi lebih lanjut tentang penggunaan Analisis Apigee API dasbor setelah add-on diaktifkan di lingkungan Apigee Anda, lihat Menggunakan dasbor analisis.

Ketersediaan

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

Peran dan izin yang diperlukan

Untuk mendapatkan izin yang Anda perlukan untuk mengelola add-on Analisis API Apigee, minta administrator untuk memberi Anda Admin Lingkungan Apigee (apigee.environment.admin) Peran IAM pada 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 Analisis API Apigee. Untuk melihat izin yang benar-benar diperlukan, luaskan bagian Izin yang diperlukan:

Izin yang diperlukan

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

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

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

Mengaktifkan add-on Analisis Apigee API

Anda dapat mengaktifkan add-on Apigee API Analytics untuk versi Menengah atau Komprehensif Lingkungan Apigee menggunakan UI Apigee di Konsol Google Cloud atau menggunakan API, sebagaimana dijelaskan dalam bagian berikut.

Apigee di konsol Google Cloud

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 Bayar sesuai penggunaan 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 (atau beberapa lingkungan) tempat Anda ingin mengaktifkan add-on.
  5. Klik Aktifkan yang dipilih.
  6. Setelah pengaktifan selesai untuk lingkungan yang dipilih, Status lingkungan akan menampilkan Enabled.
  7. Untuk melihat data Analisis API Apigee Anda, pilih Analytics > Metrik API untuk melihat data analisis Anda. Mungkin perlu waktu hingga 10 menit untuk menampilkan data analisis.

API Apigee

Untuk mengaktifkan add-on Analisis Apigee API 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 keterangan:

  • ORG_NAME adalah nama organisasi Apigee Bayar sesuai penggunaan tempat Anda ingin menambahkan Analytics ke lingkungan yang memenuhi syarat.
  • ENV_NAME adalah nama lingkungan Apigee tempat Anda ingin mengaktifkan add-on Analisis API Apigee.

Setelah pengaktifan selesai, pilih Analytics > API Metrics 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 Analisis Apigee API dapat memerlukan waktu hingga 15 menit. Setelah diaktifkan, data analisis untuk lingkungan disimpan selama 14 bulan. Anda dapat mengakses data historis lingkungan dari Metrik API di konsol, selama add-on diaktifkan.

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

Menonaktifkan add-on Analisis Apigee API

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

Jika Anda mengaktifkan add-on Advanced API Security di lingkungan, Anda harus menonaktifkan Add-on Advanced API Security sebelum Anda dapat menonaktifkan add-on Analisis API Apigee. Jika Advanced API Security add-on tidak dinonaktifkan, semua permintaan untuk menonaktifkan Analisis API Apigee di lingkungan akan gagal. Jika add-on Advanced API Security diaktifkan di lingkungan Anda, add-on ini akan ditampilkan di Kolom Add-on yang diaktifkan lainnya pada panel Kelola add-on Analytics API Apigee.

Untuk menonaktifkan add-on ini, lihat Nonaktifkan 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 Bayar sesuai penggunaan 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 (atau beberapa lingkungan) tempat Anda ingin menonaktifkan add-on.
  5. Klik Nonaktifkan yang dipilih.
  6. Setelah penonaktifan selesai, Status akan ditampilkan Dinonaktifkan untuk setiap lingkungan.

API Apigee

Untuk menonaktifkan add-on Analisis API Apigee 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 keterangan:

  • ORG_NAME adalah nama organisasi Apigee Bayar sesuai penggunaan tempat Anda ingin menambahkan Analytics ke lingkungan yang memenuhi syarat.
  • ENV_NAME adalah nama lingkungan Apigee tempat Anda ingin mengaktifkan add-on Analisis API Apigee.

Melihat status add-on Analisis Apigee API di lingkungan

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

Apigee di konsol Google Cloud

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

  1. Buka halaman Apigee di konsol.

    Buka Apigee

  2. Pilih project dengan organisasi dan lingkungan Bayar sesuai penggunaan yang ingin Anda kelola.
  3. Pilih Add-on > Analytics untuk membuka halaman add-on Analytics.
  4. Di panel Manage Apigee API Analytics add-on, 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.

API Apigee

Untuk melihat status add-on Analisis API Apigee di lingkungan 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 keterangan:

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

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

Mengelola data Analisis API Apigee Anda

Setelah add-on Analisis Apigee API diaktifkan untuk suatu lingkungan, analisis data untuk lingkungan dipertahankan selama 14 bulan. Anda dapat mengakses data analisis historis lingkungan dari Metrik API di konsol selama add-on diaktifkan.

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

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