Mengelola add-on Advanced API Security

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

Lihat Dokumentasi Apigee Edge.

Advanced API Security terus memantau API Anda untuk melindunginya dari ancaman keamanan, termasuk serangan dari klien yang berbahaya dan penyalahgunaan. Advanced API Security menganalisis traffic API Anda untuk mengidentifikasi permintaan API yang mencurigakan, dan menyediakan alat yang dapat memblokir atau menandai permintaan tersebut. Selain itu, Advanced API Security mengevaluasi konfigurasi API Anda untuk memastikan alat tersebut memenuhi standar keamanan, dan memberi Anda rekomendasi untuk meningkatkannya jika diperlukan.

Jika Anda adalah pelanggan Apigee Bayar sesuai penggunaan, Advanced API Security tersedia sebagai berbayar add-on Anda. Topik ini menjelaskan cara mengaktifkan dan mengelola Advanced API Security add-on untuk lingkungan Bayar sesuai penggunaan yang memenuhi syarat. Untuk informasi selengkapnya tentang penggunaan Advanced API Security setelah add-on diaktifkan di lingkungan Apigee Anda, lihat Ringkasan Advanced API Security.

Ketersediaan

Advanced API Security 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 Advanced API Security di lingkungan Dasar. Untuk mengetahui detail selengkapnya tentang kemampuan lingkungan Apigee, lihat Perbandingan jenis lingkungan.

Catatan: Sebelum mengaktifkan add-on Advanced API Security di lingkungan, pastikan add-on Apigee API Analytics diaktifkan untuk lingkungan tersebut. Jika Apigee API Analytics tidak diaktifkan, permintaan apa pun untuk mengaktifkan Advanced API Security di lingkungan akan gagal.

Jika add-on Apigee API Analytics diaktifkan di lingkungan Anda, add-on ini akan ditampilkan di Kolom Add-on yang diaktifkan lainnya pada panel Manage Advanced API Security add-on. Untuk mengaktifkan add-on, lihat Mengaktifkan add-on add-on Analisis API Apigee.

Peran dan izin yang diperlukan

Untuk mendapatkan izin yang Anda perlukan untuk mengelola add-on Advanced API Security, 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 Advanced API Security. Untuk melihat izin yang benar-benar diperlukan, luaskan bagian Izin yang diperlukan:

Izin yang diperlukan

Izin berikut diperlukan untuk mengelola add-on Advanced API Security:

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

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

Setelah add-on diaktifkan, peran tambahan mungkin diperlukan untuk menjalankan tugas menggunakan Advanced API Security. Untuk informasi selengkapnya, lihat Peran yang diperlukan.

Mengaktifkan add-on Advanced API Security

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

Catatan: Add-on Advanced API Security tidak dapat diaktifkan di lingkungan Dasar.

Apigee di konsol Google Cloud

Untuk mengaktifkan add-on Advanced API Security 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 > Advanced API Security untuk membuka halaman add-on Advanced API Security.
4. Di panel Manage Advanced API Security 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. Pilih Advanced API Security guna melihat opsi halaman untuk menggunakan data keamanan Anda, termasuk Penilaian risiko, Deteksi penyalahgunaan, Laporan keamanan, dan Tindakan keamanan. Mungkin perlu waktu hingga 10 menit untuk menampilkan data Advanced API Security.

API Apigee

Untuk mengaktifkan add-on Advanced API Security 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 '{"apiSecurityEnabled":true}'

Dengan keterangan:

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

Setelah pengaktifan selesai, klik Advanced API Security guna melihat opsi halaman untuk menggunakan data keamanan Anda, termasuk Penilaian risiko, Deteksi penyalahgunaan, Laporan keamanan, dan Tindakan keamanan. Mungkin perlu waktu hingga 10 menit untuk menampilkan data Advanced API Security di UI, atau tersedia melalui panggilan API.

Proses pengaktifan add-on Advanced API Security dapat memerlukan waktu hingga 15 menit. Setelah diaktifkan, data keamanan untuk lingkungan disimpan selama 14 bulan. Anda dapat mengakses data historis lingkungan dari Advanced API Security di konsol, selama add-on diaktifkan.

Penagihan untuk penggunaan add-on Advanced API Security dimulai setelah pengaktifan add-on dimulai.

Menonaktifkan add-on Advanced API Security

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

Catatan: Jika Anda menonaktifkan add-on Advanced API Security di suatu lingkungan, data keamanan akan dihapus setelah 30 hari. Untuk informasi selengkapnya, lihat Kelola data Advanced API Security Anda.

Apigee di Konsol Cloud

Untuk menonaktifkan add-on Advanced API Security 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 > Advanced API Security untuk membuka halaman add-on Advanced API Security.
4. Di panel Manage Advanced API Security 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 Advanced API Security 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 '{"apiSecurityEnabled":false}'

Dengan keterangan:

• ORG_NAME adalah nama organisasi Apigee Bayar sesuai penggunaan tempat Anda ingin menonaktifkan Advanced API Security di lingkungan yang memenuhi syarat.
• ENV_NAME adalah nama lingkungan Apigee tempat Anda ingin menonaktifkan add-on Advanced API Security.

Lihat status add-on Advanced API Security di lingkungan

Anda dapat memeriksa status add-on Advanced API Security 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 Advanced API Security 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 > Advanced API Security untuk membuka halaman add-on Advanced API Security.
4. Di panel Manage Advanced API Security 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 Advanced API Security 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 ApiSecurityConfig yang mewakili status add-on saat ini.

Mengelola data Advanced API Security Anda

Setelah add-on Advanced API Security diaktifkan untuk suatu lingkungan, data keamanan untuk lingkungan dipertahankan selama 14 bulan. Anda dapat mengakses laporan keamanan lingkungan yang sebelumnya dibuat untuk dari Laporan keamanan, di konsol, tetapi laporan baru tidak dapat dibuat.

Jika Anda menonaktifkan {i>add-on <i} {i>Advanced API Security<i} di suatu lingkungan, data keamanan untuk lingkungan akan dihapus setelah 30 hari. Jika Anda mengaktifkan kembali add-on dengan cara dalam waktu 30 hari setelah penonaktifan, Anda bisa mendapatkan kembali akses ke data keamanan 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 laporan keamanan untuk lingkungan apa pun di luar periode retensi data 14 bulan, sebaiknya mengekspor dan menyimpan data Anda di lokasi lain. Anda mungkin juga ingin mengekspor Advanced API Security data sebelum menonaktifkan add-on, atau dalam periode 30 hari setelah penonaktifan. Anda dapat mengekspor laporan keamanan Anda menggunakan tombol Ekspor di halaman Laporan keamanan di konsol atau download laporan menggunakan Security reports API.