Über Routen

Sie können Routen in Ihrem Konto über die IBM Cloud Logs Routing UI, die IBM Cloud Logs Routing CLI, die IBM Cloud Logs Routing REST API V3 und den IBM Cloud Logs Routing Terraform Provider verwalten. Eine Route definiert die Regeln, die angeben, welche Plattformprotokolle in einer Region weitergeleitet werden und wohin sie geleitet werden sollen.

Verstehen, wie Routen auf Ihrem Konto funktionieren

Beachten Sie die folgenden Informationen zu den Routen:

  • Routen sind unter einem Konto global und werden in allen Regionen ausgewertet, in denen IBM Cloud Logs Routing eingesetzt wird.

  • Auf die Routen kann von jedem regionalen IBM Cloud Logs Routing API-Endpunkt aus zugegriffen werden.

  • Für ein Konto können Sie bis zu 30 Routen definieren.

  • Das Konto hat standardmäßig 0 Routen konfiguriert.

  • Pro Route können Sie bis zu 10 Regeln konfigurieren.

  • Sie können bis zu acht Standorte für jede Regel konfigurieren.

  • Sie können für jede Regel bis zu drei Ziele ({ "targets": [{ "id": ID1 },{ "id": ID2 },{ "id": ID3 }] }) konfigurieren.

  • Routen werden unabhängig voneinander verarbeitet. Wenn Sie mehrere Routen mit Regeln haben, die mit denselben Plattformprotokolldaten übereinstimmen, werden diese Daten an mehrere Ziele gesendet.

  • Regeln in einer einzelnen Routendefinition werden der Reihe nach abgearbeitet. Die erste übereinstimmende Regel (z. B. location), die mit Plattformprotokolldaten übereinstimmt, wird zur Verarbeitung dieser Daten verwendet. Wenn Plattformprotokolle verarbeitet werden, werden sie nicht von einer nachfolgenden Regel innerhalb der Definition dieser Route verarbeitet.

  • Regeln werden mit einem Plattformprotokoll übereinstimmen, wenn der Speicherort des Plattformprotokolls innerhalb eines Regelspeichers liegt. Zum Beispiel passt die Regel eu-de zu Plattformprotokollpositionen: eu-de, eu-de-1, eu-de-2, und eu-de-3. Oder die Regel Standort jp passt zu allen Plattformprotokollen in Japan. Führen Sie ibmcloud catalog locations aus, um die Hierarchien der Cloud-Standorte zu sehen.

  • Wenn die Plattformprotokolldaten keiner Regel entsprechen und kein Standardziel konfiguriert ist, werden die Plattformprotokolle verworfen und nicht an ein Ziel weitergeleitet.

  • Jede Aktualisierung einer oder mehrerer Regeln in einer Routendefinition verwirft den bestehenden Regelsatz und ersetzt ihn durch die angegebene Konfiguration. Wenn Sie eine Route aktualisieren, müssen Sie alle bestehenden Regeln im Regelsatz definieren, die sich nicht ändern, und die Änderungen zu den Regeln hinzufügen, die aktualisiert werden müssen.

  • Informationen über Routen werden als Metadaten an dem primären Speicherort gespeichert, den Sie für das Konto IBM Cloud festgelegt haben.

  • Sie können private und öffentliche Endpunkte verwenden, um Routen zu verwalten. Weitere Informationen zu der Liste der verfügbaren ENDPOINTS finden Sie unter Endpunkte.

    • Sie können Routen aus dem privaten Netz verwalten, indem Sie einen API-Endpunkt mit dem folgenden Format verwenden: https://api.private.REGION.logs-router.cloud.ibm.com

    • Sie können Routen aus dem öffentlichen Netz verwalten, indem Sie einen API-Endpunkt mit dem folgenden Format verwenden: https://api.REGION.logs-router.cloud.ibm.com

    • Sie können die öffentlichen Endpunkte inaktivieren, indem Sie die Kontoeinstellungen aktualisieren. Weitere Informationen finden Sie unter Erzwingen von privaten Endpunkten.

  • Der Routenname darf höchstens 1000 Zeichen lang sein und darf keine anderen Sonderzeichen als Leerzeichen, Bindestrich -, Punkt ., Unterstrich _ und Doppelpunkt : enthalten.

    Der Name darf keine persönlichen Informationen zur Identifizierung (PII) enthalten.

Nach der Konfiguration einer Route kann es bis zu eine Stunde dauern, bis die Konfiguration aktiviert wird.

IAM-Zugriff

Stellen Sie sicher, dass Sie die die richtigen IAM-Berechtigungen zur Konfiguration von IBM Cloud Logs Routing.

IAM-Berechtigungen

In der folgenden Tabelle sind die IAM-Aktionen, ihr Umfang und die für die Verwaltung von Routen erforderlichen Rollen aufgeführt.

IAM-Aktionsbereiche und Rollen für die Verwaltung von Routen
Task IAM-Aktion Geltungsbereich der IAM-Richtlinie IAM-Rollen
Route erstellen logs-router.route.create Konto Administrator
Editor
Alle Routen auflisten logs-router.route.list Konto Administrator
Editor
Operator
Viewer
Details zu einer Route abrufen logs-router.route.read Konto Administrator
Editor
Operator
Viewer
Ändern einer Route logs-router.route.update Konto Administrator
Editor
Route löschen logs-router.route.delete Konto Administrator
Editor

Ereignisse prüfen

In der folgenden Tabelle sind die IAM-Aktionen, ihr Umfang und die für die Verwaltung von Routen erforderlichen Rollen aufgeführt.

Aktivitätsnachverfolgung Auditing von Ereignissen
Task Aktivitätsverfolgung Auditing Ereignis Aktion
Route erstellen logs-router.route.create
Alle Routen auflisten logs-router.route.list
Details zu einer Route abrufen logs-router.route.read
Ändern einer Route logs-router.route.update
Route löschen logs-router.route.delete

CLI-Voraussetzungen

Bevor Sie die Befehlszeilenschnittstelle zur Verwaltung von Routen verwenden, führen Sie die folgenden Schritte aus:

  1. Installieren Sie die IBM Cloud-Befehlszeilenschnittstelle.

  2. Installieren Sie die IBM Cloud Logs Routing CLI.

Verwaltung von Routen über die Benutzeroberfläche

Sie können Ihre Routendefinition über die Benutzeroberfläche IBM Cloud Logs Routing verwalten. Weitere Informationen finden Sie unter Verwalten von Routen.

Befehle der Befehlszeilenschnittstelle

In der folgenden Tabelle werden die Aktionen aufgelistet, die zum Verwalten von Routen ausgeführt werden können:

Routen-Aktionen
Aktion Befehl
Route erstellen ibmcloud logs-router route create
Route aktualisieren ibmcloud logs-router route update
Route löschen ibmcloud logs-router route delete
Route lesen ibmcloud logs-router route get
Alle Routen auflisten ibmcloud logs-router route list

Weitere Informationen finden Sie unter IBM Cloud Logs Routing v3 CLI.

API-Voraussetzungen

Bevor Sie die API zur Verwaltung von Routen verwenden, führen Sie die folgenden Schritte aus:

  1. Rufen Sie ein IAM-Zugriffstoken ab. Weitere Informationen finden Sie unter Abrufen von IAM-Zugriffstokens.
  2. Geben Sie den API-Endpunkt in der Region an, in der Sie eine Route konfigurieren oder verwalten wollen. Weitere Informationen finden Sie unter Endpunkte.

API-Methoden

In der folgenden Tabelle werden die Aktionen aufgelistet, die zum Verwalten von Routen ausgeführt werden können:

Weiterleitung von Aktionen über die IBM Cloud Logs Routing REST API
Aktion REST-API-Methode API_URL
Create a route POST <ENDPOINT>/v3/routes
Update a route PATCH <ENDPOINT>/v3/routes/<ROUTE_ID>
Delete a route DELETE <ENDPOINT>/v3/routes/<ROUTE_ID>
Get information about a route GET <ENDPOINT>/v3/routes/<ROUTE_ID>
List all routes GET <ENDPOINT>/v3/routes

Weitere Informationen über die REST-API finden Sie unter Routes.

HTTP-Antwortcodes

Wenn Sie die IBM Cloud Logs Routing REST-API verwenden, können Sie Standard-HTTP-Antwortcodes abrufen, um anzugeben, ob eine Methode erfolgreich abgeschlossen wurde.

  • Eine Antwort von 200 zeigt immer Erfolg an.
  • Eine 4xx-Antwort weist auf einen Fehler hin.
  • Eine 5xx-Antwort weist normalerweise auf einen internen Systemfehler hin.

In der folgenden Tabelle finden Sie einige HTTP-Antwortcodes:

Liste der Antwortcodes HTTP
Statuscode Status Beschreibung
200 OK Die Anforderung war erfolgreich.
201 OK Die Anforderung war erfolgreich. Eine Ressource wird erstellt.
204 OK Die Route wurde erfolgreich gelöscht.
400 Ungültige Anforderung Die Anforderung war nicht erfolgreich. Möglicherweise fehlt ein Parameter, der erforderlich ist.
401 Nicht berechtigt Das IAM-Token, das in der API-Anforderung verwendet wird, ist ungültig oder abgelaufen.
403 Nicht zulässig Die Operation ist aufgrund unzureichender Berechtigungen nicht zulässig.
404 Nicht gefunden Die angeforderte Ressource ist nicht vorhanden oder wurde bereits gelöscht.
429 Zu viele Anforderungen Zu viele Anfragen erreichen die API zu schnell.
500 Interner Serverfehler In der IBM Cloud Logs Routing Verarbeitung ist etwas schief gelaufen.