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 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 konfigurasi tersebut memenuhi standar keamanan, dan memberikan rekomendasi untuk meningkatkannya jika diperlukan.

Jika Anda adalah pelanggan Apigee dengan model Bayar sesuai penggunaan, Advanced API Security tersedia sebagai add-on berbayar. Topik ini menjelaskan cara mengaktifkan dan mengelola add-on Keamanan API Lanjutan untuk lingkungan Bayar sesuai penggunaan yang memenuhi syarat. Untuk mengetahui 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 penerapan Apigee Anda. Add-on dapat diaktifkan di lingkungan Menengah atau Komprehensif Apigee. Anda tidak dapat mengaktifkan dan menggunakan Keamanan API Lanjutan 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 Keamanan API Lanjutan, minta administrator untuk memberi Anda peran IAM Admin 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 Keamanan API Lanjutan. Untuk melihat izin yang benar-benar diperlukan, luaskan bagian Izin yang diperlukan:

Izin yang diperlukan

Izin berikut diperlukan untuk mengelola add-on Keamanan API Lanjutan:

  • 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 melakukan tugas menggunakan Keamanan API Lanjutan. Untuk mengetahui informasi selengkapnya, lihat Peran yang diperlukan.

Mengaktifkan add-on Advanced API Security

Anda dapat mengaktifkan add-on Keamanan API Lanjutan 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 Advanced API Security 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 > Advanced API Security untuk membuka halaman Advanced API Security add-on.
  4. Di panel Manage Advanced API Security 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. Pilih Advanced API Security untuk melihat opsi halaman guna 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.

Apigee API

Untuk mengaktifkan add-on Keamanan API Lanjutan 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:

  • ORG_NAME adalah nama organisasi Apigee Pay-as-you-go 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 untuk melihat opsi halaman guna menggunakan data keamanan Anda, termasuk Penilaian risiko, Deteksi penyalahgunaan, Laporan keamanan, dan Tindakan keamanan. Diperlukan 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 dipertahankan 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 Keamanan API Lanjutan 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 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 Pay-as-you-go yang ingin Anda kelola.
  3. Pilih Add-on > Advanced API Security untuk membuka halaman Advanced API Security add-on.
  4. Di panel Kelola add-on Keamanan API Lanjutan, 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 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:

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

Melihat status add-on Keamanan API Tingkat Lanjut 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 Google Cloud console

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 Pay-as-you-go yang ingin Anda kelola.
  3. Pilih Add-on > Advanced API Security untuk membuka halaman Advanced API Security add-on.
  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 kedua status tersebut.

Apigee API

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:

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

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

Mengelola data Keamanan API Lanjutan Anda

Setelah add-on Keamanan API Lanjutan diaktifkan untuk lingkungan, data keamanan untuk lingkungan tersebut akan dipertahankan selama 14 bulan. Anda dapat mengakses laporan keamanan 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 setelah penonaktifan, Anda dapat memperoleh kembali akses ke data keamanan 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 laporan keamanan untuk lingkungan apa pun di luar periode retensi 14 bulan, sebaiknya ekspor dan simpan data Anda di lokasi lain. Anda juga dapat mengekspor data Keamanan API Lanjutan sebelum menonaktifkan add-on, atau dalam jangka waktu 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.