Mengelola add-on Analisis Apigee API

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

Baca 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 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 Bayar sesuai penggunaan, Apigee API Analytics tersedia sebagai add-on berbayar. Topik ini menjelaskan cara mengaktifkan dan mengelola add-on Analisis Apigee API untuk lingkungan Bayar sesuai penggunaan yang memenuhi syarat. Untuk informasi selengkapnya tentang penggunaan dasbor Analisis API Apigee setelah add-on diaktifkan di lingkungan Apigee, lihat Menggunakan dasbor analisis.

Ketersediaan

Analisis API Apigee tersedia sebagai kemampuan add-on berbayar yang dikelola untuk setiap lingkungan Apigee dalam implementasi Apigee Anda. Add-on ini dapat diaktifkan di semua lingkungan Apigee Intermediate atau Comprehensive. Anda tidak dapat mengaktifkan dan menggunakan Analisis Apigee API di lingkungan Dasar. 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 Analytics Apigee API, minta administrator Anda untuk memberi Anda peran IAM Apigee Environment Admin (apigee.environment.admin) di project. Untuk mengetahui informasi selengkapnya tentang cara memberikan peran, lihat Mengelola akses.

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

Izin yang diperlukan

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

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

Anda mung juga bisa mendapatkan izin ini dengan peran khusus atau peran bawaanlainnya.

Mengaktifkan add-on Analisis API Apigee

Anda dapat mengaktifkan 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 Konsol Google Cloud

Untuk mengaktifkan add-on Analytics Apigee API 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 lingkungan) tempat Anda ingin mengaktifkan add-on.
  5. Klik Enable selected.
  6. Setelah pengaktifan selesai untuk lingkungan yang dipilih, Status lingkungan akan menampilkan Enabled.
  7. Untuk melihat data Analytics Apigee API, pilih Analytics > API Metrics untuk melihat data analisis Anda. Mungkin perlu waktu hingga 10 menit untuk menampilkan data analisis.

API Apigee

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

curl -X POST \
  http://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 Analytics Apigee API.

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

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

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

Menonaktifkan add-on Analytics Apigee API

Anda dapat menonaktifkan 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.

Jika add-on Advanced API Security diaktifkan di lingkungan, Anda harus menonaktifkan add-on Advanced API Security sebelum dapat menonaktifkan add-on Analytics Apigee API. Jika add-on Advanced API Security tidak dinonaktifkan, permintaan apa pun untuk menonaktifkan Apigee API Analytics di lingkungan akan gagal. Jika diaktifkan di lingkungan Anda, add-on Advanced API Security akan ditampilkan di kolom Other enabled add-on pada 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 Analytics Apigee API 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 lingkungan) tempat Anda ingin menonaktifkan add-on tersebut.
  5. Klik Nonaktifkan yang dipilih.
  6. Setelah penonaktifan selesai, Status akan menampilkan Disabled untuk setiap lingkungan.

API Apigee

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

curl -X POST \
  http://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 Analytics Apigee API.

Melihat status add-on Analytics Apigee API di lingkungan

Anda dapat memeriksa status add-on Analisis Apigee API untuk lingkungan Apigee Menengah atau Komprehensif 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 Analytics Apigee API di 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 kedua status tersebut.

API Apigee

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

curl -X GET \
  http://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.

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

Mengelola data Analisis API Apigee Anda

Setelah add-on Analytics Apigee API diaktifkan untuk suatu 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 Analytics Apigee API 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 sejak penonaktifan, Anda dapat memperoleh kembali akses ke data analisis untuk lingkungan tersebut melalui periode retensi data selama 14 bulan. Data tidak akan dipulihkan jika add-on diaktifkan kembali untuk lingkungan setelah 30 hari.

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