SOAR-Endpunkte zur Chronicle API migrieren

Unterstützt in:

In diesem Dokument werden die Schritte und Überlegungen für die Migration von der eingestellten SOAR API-Oberfläche zur einheitlichen Chronicle API beschrieben. Dieser Leitfaden soll Ihnen helfen, reibungslos und effizient umzusteigen, Unterbrechungen zu minimieren und die neuen Funktionen zu nutzen.

Die Chronicle API-Oberfläche bietet mehrere Verbesserungen, die Ihren Entwicklungsprozess optimieren sollen. Außerdem werden Einschränkungen und Komplexitäten der älteren API behandelt.

Vorbereitung

Bevor Sie die SOAR API-Migration durchführen, müssen Sie Folgendes tun:

Wichtige Änderungen und Verbesserungen

In der folgenden Tabelle werden die wichtigsten Unterschiede zwischen den alten und neuen API-Oberflächen aufgeführt:

Funktionsbereich Alte API Neue API Details
Authentifizierung API-Token oauth 2.0 Die neue Authentifizierungsmethode bietet mehr Sicherheit und standardisiert den Prozess.
Datenmodelle Einfache Strukturen Ressourcenorientiertes Design Dieses neue Design verbessert die Datenkonsistenz und vereinfacht die Objektbearbeitung.
Endpunktbenennung Inkonsistent RESTful und standardisiert Durch eine einheitliche Namensgebung wird die API intuitiver und lässt sich einfacher einbinden.

Zeitplan für die Einstellung

Die alte API-Oberfläche für SOAR wird voraussichtlich am 30. Juni 2026 vollständig eingestellt. Wir empfehlen Ihnen, die Migration vor diesem Datum abzuschließen, um Dienstunterbrechungen zu vermeiden.

Migrationsschritte

In diesem Abschnitt werden die Schritte beschrieben, die für die erfolgreiche Migration Ihrer Anwendungen zur Chronicle API erforderlich sind:

Dokumentation lesen

Machen Sie sich mit der umfassenden Dokumentation für die neue API vertraut, einschließlich des Chronicle API-Referenzhandbuchs.

Endpunkte der alten API der neuen API zuordnen

Suchen Sie für jeden der alten API-Aufrufe, die Ihre Anwendung ausführt, die entsprechenden neuen Endpunkte. Ordnen Sie die alten Datenmodelle den neuen zu und berücksichtigen Sie dabei alle strukturellen Änderungen oder neuen Felder. Weitere Informationen finden Sie in der Tabelle zur Zuordnung von API-Endpunkten.

Optional: Staging-Integration erstellen

Wenn Sie eine benutzerdefinierte Integration oder eine Komponente einer kommerziellen Integration bearbeiten, empfehlen wir, die Änderungen zuerst in eine Staging-Integration zu übertragen. So können Sie Tests durchführen, ohne Ihre Produktionsautomatisierungsabläufe zu beeinträchtigen. Wenn Sie eine benutzerdefinierte Anwendung migrieren, die die SOAR API verwendet, können Sie mit dem nächsten Schritt fortfahren. Weitere Informationen zum Staging von Integrationen finden Sie unter Integrationen im Staging-Modus testen.

Dienstendpunkt und URLs aktualisieren

Ein Dienstendpunkt ist die Basis-URL, die die Netzwerkadresse eines API-Dienstes angibt. Ein einzelner Dienst kann mehrere Dienstendpunkte haben. Chronicle ist ein regionaler Dienst und unterstützt nur regionale Endpunkte.

Alle neuen Endpunkte verwenden ein einheitliches Präfix, sodass die endgültige Endpunktadresse vorhersehbar ist. Das folgende Beispiel zeigt die neue Endpunkt-URL-Struktur:

[api_version]/projects/[project_id]/locations/[location]/instances[instance_id]/...

Die endgültige Adresse des Endpunkts sieht dann so aus:

https://[service_endpoint]/[api_version]/projects/[project_id]/locations/[location]/instances/[instance_id]/...

Wobei:

  • service_endpoint: Eine regionale Dienstadresse
  • api_version: Die API-Version, die abgefragt werden soll. Kann v1alpha, v1beta oder v1 sein.
  • project_id: Ihre Projekt-ID (dasselbe Projekt, das Sie für Ihre IAM-Berechtigungen definiert haben)
  • location: Der Standort Ihres Projekts (Region), entspricht den regionalen Endpunkten.
  • instance_id: Ihre Google Security Operations SIEM-Kunden-ID.

Regionale Adressen:

  • africa-south1: https://chronicle.africa-south1.rep.googleapis.com

  • asia-northeast1: https://chronicle.asia-northeast1.rep.googleapis.com

  • asia-south1: https://chronicle.asia-south1.rep.googleapis.com

  • asia-southeast1: https://chronicle.asia-southeast1.rep.googleapis.com

  • asia-southeast2: https://chronicle.asia-southeast2.rep.googleapis.com

  • australia-southeast1: https://chronicle.australia-southeast1.rep.googleapis.com

  • europe-west12: https://chronicle.europe-west12.rep.googleapis.com

  • europe-west2: https://chronicle.europe-west2.rep.googleapis.com

  • europe-west3: https://chronicle.europe-west3.rep.googleapis.com

  • europe-west6: https://chronicle.europe-west6.rep.googleapis.com

  • europe-west9: https://chronicle.europe-west9.rep.googleapis.com

  • me-central1: https://chronicle.me-central1.rep.googleapis.com

  • me-central2: https://chronicle.me-central2.rep.googleapis.com

  • me-west1: https://chronicle.me-west1.rep.googleapis.com

  • northamerica-northeast2: https://chronicle.northamerica-northeast2.rep.googleapis.com

  • southamerica-east1: https://chronicle.southamerica-east1.rep.googleapis.com

  • uns: https://chronicle.us.rep.googleapis.com

  • eu: https://chronicle.eu.rep.googleapis.com

So rufen Sie beispielsweise eine Liste aller Fälle für ein Projekt in den USA ab:

GET 
  https://chronicle.us.rep.googleapis.com/v1alpha/projects/my-project-name-or-id/locations/us/instances/408bfb7b-5746-4a50-885a-50a323023529/cases

Authentifizierungsmethode aktualisieren

Die neue API verwendet Google Cloud IAM für die Authentifizierung. Sie müssen Ihre Anwendung oder Antwortintegration aktualisieren, um diesen neuen Authentifizierungsablauf zu implementieren. Prüfen Sie, ob der Nutzer, der das Script ausführt, die richtigen Berechtigungen für die Endpunkte hat, auf die er zugreifen möchte.

API-Logik aktualisieren

Analysieren Sie die neuen Datenmodelle und Endpunktstrukturen, die in der API-Referenz angegeben sind. Nicht alle Methoden haben sich wesentlich geändert und vorhandener Code kann teilweise wiederverwendet werden. Das Hauptziel besteht darin, die neue Referenzdokumentation zu prüfen und für jeden spezifischen Anwendungsfall die erforderlichen Änderungen an Feldnamen und Datenstrukturen in der Logik Ihrer Anwendung zu ermitteln und zu implementieren.

Integration testen

Testen Sie Ihre aktualisierte Anwendung in einer Staging-Integration, bevor Sie sie in der Produktionsumgebung bereitstellen:

  1. Testplan erstellen: Definieren Sie Testläufe, die alle migrierten Funktionen abdecken.
  2. Tests ausführen: Führen Sie automatisierte und manuelle Tests durch, um die Richtigkeit und Gültigkeit zu bestätigen.
  3. Leistung beobachten: Bewerten Sie die Leistung Ihrer Anwendung mit der neuen API.

Benötigen Sie weitere Hilfe? Antworten von Community-Mitgliedern und Google SecOps-Experten erhalten