Mengelola add-on Advanced API Security

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

Baca dokumentasi Apigee Edge.

Advanced API Security terus memantau API Anda untuk melindunginya dari ancaman keamanan, termasuk serangan dari klien 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 memastikannya memenuhi standar keamanan, dan memberikan rekomendasi untuk meningkatkannya jika diperlukan.

Jika Anda adalah pelanggan Apigee Bayar sesuai penggunaan, Advanced API Security tersedia sebagai add-on berbayar. Topik ini menjelaskan cara mengaktifkan dan mengelola add-on Keamanan API Tingkat Lanjut untuk lingkungan Bayar sesuai penggunaan yang memenuhi syarat. Untuk informasi selengkapnya tentang penggunaan Advanced API Security setelah add-on diaktifkan di lingkungan Apigee, 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 ini dapat diaktifkan di semua lingkungan Apigee Intermediate atau Comprehensive. 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 Analytics Apigee API diaktifkan untuk lingkungan tersebut. Jika Analytics Apigee API tidak diaktifkan, permintaan apa pun untuk mengaktifkan Advanced API Security di lingkungan akan gagal.

Jika diaktifkan di lingkungan Anda, add-on Analytics Apigee API akan ditampilkan di kolom Other enabled add-on pada panel Manage Advanced API Security add-on. Untuk mengaktifkan add-on, lihat Mengaktifkan add-on Analytics Apigee API.

Peran dan izin yang diperlukan

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

Izin yang diperlukan

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

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

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

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

Mengaktifkan add-on Advanced API Security

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

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

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, pilih kotak centang 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. Pilih Keamanan API Tingkat Lanjut 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 '{"api_security_enabled":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 tersebut akan disimpan selama 14 bulan. Anda dapat mengakses data historis lingkungan dari halaman 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 lingkungan Apigee Menengah atau Komprehensif 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 lingkungan, data keamanan akan dihapus setelah 30 hari. Untuk informasi selengkapnya, lihat Mengelola 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, pilih kotak centang untuk lingkungan (atau lingkungan) tempat Anda ingin menonaktifkan add-on.
5. Klik Nonaktifkan yang dipilih.
6. Setelah penonaktifan selesai, Status akan menampilkan Disabled 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 '{"api_security_enabled":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.

Melihat status add-on Advanced API Security di lingkungan

Anda dapat memeriksa status add-on Advanced API Security 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 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 add-on Manage Advanced API Security, 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 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.

Responsnya akan 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 tersebut akan disimpan selama 14 bulan. Anda dapat mengakses laporan keamanan lingkungan yang sebelumnya dibuat untuk lingkungan dari halaman Laporan keamanan di konsol, tetapi laporan baru tidak dapat dibuat.

Jika Anda menonaktifkan add-on Advanced API Security di lingkungan, data keamanan 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 bisa mendapatkan kembali akses ke data keamanan untuk lingkungan tersebut melalui periode retensi data 14 bulan. Data tidak akan dipulihkan jika add-on diaktifkan kembali untuk lingkungan setelah 30 hari.

Jika Anda ingin mempertahankan laporan keamanan untuk lingkungan apa pun setelah periode retensi data 14 bulan, sebaiknya ekspor dan simpan data Anda di lokasi lain. Anda juga dapat mengekspor data Advanced API Security sebelum menonaktifkan add-on, atau dalam periode 30 hari setelah penonaktifan. Anda dapat mengekspor laporan keamanan menggunakan tombol Ekspor di halaman Laporan keamanan di konsol atau mendownload laporan menggunakan Security reports API.