Halaman ini menjelaskan perbedaan antara Security Command Center API versi 1 (v1) dan versi 2 (v2). Panduan ini juga menjelaskan cara bermigrasi ke Security Command Center API v2, yang dikombinasikan dengan Security Command Center Management API v1.
Mulai 9 Desember 2024, jika Anda mengaktifkan Security Command Center dalam organisasi untuk pertama kalinya, Anda hanya boleh menggunakan Security Command Center API versi 2 di organisasi tersebut. Versi sebelumnya tidak didukung.
Jika Anda mengaktifkan Security Command Center di level project sebelum 9 Desember 2024, maka project apa pun yang Anda aktifkan di organisasi yang sama akan mendukung semua versi Security Command Center API yang tersedia.
Untuk semua integrasi dengan Security Command Center, sebaiknya Anda menggunakan Security Command Center API v2 dan Security Command Center Management API v1. Sebaiknya gunakan Library Klien Cloud atau penyedia Google Cloud Terraform untuk memanggil API ini. Untuk informasi selengkapnya, lihat referensi berikut:
Terraform
Library klien
Perbedaan antara API v1 dan v2
Saat Anda bermigrasi ke Security Command Center API v2, perhatikan perbedaan berikut dari API v1.
Residensi data
Security Command Center API v2 mendukung residensi data, yang memberi Anda kontrol lebih besar atas lokasi data Security Command Center Anda:
- Untuk semua lokasi, jika jenis resource tunduk pada kontrol retensi data, Anda dapat menentukan lokasi saat memanggil metode jenis resource.
- Untuk lokasi tempat residensi data diterapkan saat digunakan dan dalam pengiriman, endpoint layanan regional tersedia untuk menggunakan jenis resource yang tunduk pada kontrol residensi data.
Meskipun Anda belum
mengaktifkan retensi data untuk
organisasi, sebaiknya panggil versi berbasis lokasi dari setiap
metode dan tentukan lokasi global. Dengan demikian, Anda akan lebih mudah mengadopsi residensi data
di masa mendatang.
Jika telah mengaktifkan retensi data untuk organisasi, Anda harus menggunakan metode berbasis lokasi dan, jika berlaku, endpoint layanan regional untuk lokasi yang Anda pilih.
Untuk menggunakan versi setiap metode yang mempertimbangkan lokasi, lakukan hal berikut:
Konsol
Konsol Google Cloud menggunakan versi setiap metode yang mempertimbangkan lokasi jika diperlukan.
gcloud
Saat menjalankan perintah gcloud CLI yang memungkinkan Anda menentukan lokasi, seperti gcloud scc findings list, selalu berikan lokasi. Ada beberapa cara untuk melakukannya:
- Menggunakan flag
--location. - Jika Anda memberikan jalur lengkap nama resource, gunakan format yang menentukan lokasi, seperti
projects/123/sources/456/locations/global/findings/a1b2c3.
Terraform
Selalu berikan argumen location untuk resource yang mendukungnya, seperti
google_scc_v2_organization_mute_config.
REST
Panggil versi metode dengan locations dalam namanya. Misalnya,
panggil
organizations.locations.findings.bulkMute,
bukan
organizations.findings.bulkMute.
Library klien
Lihat contoh kode untuk Security Command Center atau referensi API untuk library klien Anda.
Konfigurasi notifikasi dan konfigurasi BigQuery Export
Security Command Center API v1 memungkinkan Anda membuat dan mengelola jenis konfigurasi ekspor berikut:
- Konfigurasi notifikasi, yang mengirim temuan ke Pub/Sub
- Konfigurasi BigQuery Export, yang melakukan streaming temuan ke BigQuery
Anda juga dapat membuat dan mengelola konfigurasi ekspor ini dengan Security Command Center API v2. Namun, jika Anda membuat konfigurasi ekspor dengan Security Command Center API v1, konfigurasi tersebut tidak akan terlihat di Security Command Center API v2. Demikian pula, jika Anda membuat konfigurasi ekspor dengan Security Command Center API v2, konfigurasi tersebut tidak akan terlihat di Security Command Center API v1.
Selain itu, konfigurasi ekspor yang Anda buat dengan Security Command Center API v2 tidak dapat menggunakan kolom source_properties untuk
memfilter temuan. Sebagai gantinya, Anda harus
menggunakan kolom lain.
Konsol
Di konsol Google Cloud, jika konfigurasi ekspor dibuat dengan Security Command Center API v1, konfigurasi tersebut akan memiliki label Lama. Anda dapat menggunakan konsol Google Cloud untuk mengelola resource ini.
Jika Anda membuat konfigurasi ekspor baru di konsol Google Cloud, konfigurasi tersebut akan selalu dibuat dengan Security Command Center API v2.
gcloud
Untuk mengelola konfigurasi ekspor yang dibuat dengan Security Command Center API v1, jangan tentukan lokasi saat Anda menjalankan perintah gcloud CLI seperti gcloud scc notifications describe:
- Jangan gunakan flag
--location. - Jika Anda memberikan jalur lengkap untuk ID konfigurasi, gunakan format yang tidak menentukan lokasi, seperti
organizations/123/notificationConfigs/456. Jangan gunakan format sepertiorganizations/123/locations/global/notificationConfigs/456.
Demikian pula, untuk membuat atau mengelola konfigurasi ekspor dengan Security Command Center API v2, tentukan lokasi saat Anda menjalankan perintah gcloud CLI. Saat membuat konfigurasi baru, sebaiknya gunakan Security Command Center API v2.
Terraform
File konfigurasi Terraform menentukan konfigurasi ekspor sebagai resource v1 atau v2. Misalnya, lihat referensi untuk konfigurasi notifikasi:
- v1
- v2
Saat membuat konfigurasi baru, sebaiknya buat resource v2.
REST
Untuk mengelola konfigurasi ekspor yang dibuat dengan Security Command Center API v1, Anda harus menggunakan Security Command Center API v1.
Saat membuat konfigurasi baru, sebaiknya gunakan Security Command Center API v2.
Library klien
Untuk mengelola konfigurasi ekspor yang dibuat dengan Security Command Center API v1, Anda harus menggunakan Library Klien Cloud untuk Security Command Center API v1.
Saat membuat konfigurasi baru, sebaiknya gunakan Security Command Center API v2.
Layanan bawaan dan modul kustom
Security Command Center API v1 memungkinkan Anda melihat dan memperbarui jenis resource berikut:
- Layanan bawaan Security Command Center dan status pengaktifannya
- Modul kustom untuk layanan bawaan berikut:
Untuk mengelola jenis resource ini, gunakan Security Command Center Management API dan library klien-nya. Security Command Center API v2 tidak dapat mengelola jenis resource ini.
Manajemen aset
Jika organisasi Anda mengaktifkan Security Command Center sebelum 20 Juni 2023, Anda dapat menggunakan Security Command Center API v1 untuk melihat aset di organisasi, folder, atau project. Fitur pengelolaan aset Security Command Center ini tidak digunakan lagi dan tidak tersedia di Security Command Center API v2. Fitur ini akan dihapus dari Security Command Center API v1 pada atau setelah 20 Juni 2024.
Sebagai gantinya, Anda dapat menggunakan Inventaris Aset Cloud untuk melihat aset, termasuk tanda keamanannya. Untuk mengetahui detailnya, lihat Mencantumkan aset.
Anda juga dapat menggunakan Security Command Center API v2 untuk memperbarui tanda keamanan untuk aset Anda. Metode Security Command Center API yang memperbarui tanda keamanan tidak dihentikan.
Mengupdate library klien dan penyedia Terraform
Untuk mengupdate kode Anda agar dapat menggunakan Security Command Center API v2, lakukan hal berikut:
Terraform
Instal penyedia Terraform versi saat ini untuk Google Cloud. Untuk mengetahui detailnya, lihat dokumentasi penyedia.
Selain itu, perbarui file konfigurasi Terraform Anda untuk membuat resource yang dimulai dengan awalan google_scc_v2_ atau google_scc_management_. Perhatikan bahwa resource berikut tidak dibagikan di seluruh API v1 dan v2:
google_scc_folder_notification_configgoogle_scc_folder_scc_big_query_exportgoogle_scc_notification_configgoogle_scc_organization_scc_big_query_exportgoogle_scc_project_notification_configgoogle_scc_project_scc_big_query_export
Jika Anda menerapkan rencana eksekusi Terraform yang mengganti resource ini dengan ekuivalent v2-nya, Terraform akan menghapus konfigurasi v1 dan membuat konfigurasi v2 baru.
C++
Perbarui aplikasi Anda untuk menyertakan file header v2 library klien:
#include "google/cloud/securitycenter/v2/security_center_client.h"
Selain itu, update aplikasi Anda untuk menggunakan class di namespace v2:
namespace securitycenter = ::google::cloud::securitycenter_v2;
C#
Instal library klien v2, lalu update aplikasi Anda untuk menggunakan library tersebut:
Install-Package Google.Cloud.SecurityCenter.V2
Go
Instal library klien v2, lalu update aplikasi Anda untuk menggunakan library tersebut:
go get cloud.google.com/go/securitycenter/apiv2
Java
Instal library klien versi saat ini. Untuk mengetahui detailnya, lihat Menginstal library klien.
Selain itu, update aplikasi Anda untuk menggunakan class, antarmuka, dan enum
dalam
paket com.google.cloud.securitycenter.v2.
Node.js
Instal library klien versi saat ini. Untuk mengetahui detailnya, lihat Menginstal library klien.
Selain itu, update aplikasi Anda untuk menggunakan
v2.SecurityCenterClient
dan class, antarmuka, dan enum di
namespace protos.google.cloud.securitycenter.v2.
PHP
Instal library klien versi saat ini. Untuk mengetahui detailnya, lihat Menginstal library klien.
Selain itu, perbarui aplikasi Anda untuk menggunakan class dan enum di
namespace Google \ Cloud \ SecurityCenter \ V2.
Python
Instal library klien versi saat ini. Untuk mengetahui detailnya, lihat Menginstal library klien.
Selain itu, update aplikasi Anda untuk menggunakan class dalam
paket google.cloud.securitycenter_v2.
Ruby
Instal library klien versi saat ini. Untuk mengetahui detailnya, lihat Menginstal library klien.
Selain itu, perbarui aplikasi Anda untuk menetapkan parameter version ke :v2
saat membuat objek klien.
Jika Anda perlu mengelola secara terprogram layanan bawaan Security Command Center dan status pengaktifannya, atau modul kustom untuk Event Threat Detection atau Security Health Analytics, Anda juga harus menginstal library klien untuk Security Command Center Management API dan mengupdate aplikasi untuk menggunakan library klien tersebut.