CLI-Voraussetzungen

Bevor Sie die CLI zur Verwaltung von Routen verwenden, installieren Sie das neueste „ Activity Tracker Event Routing “-CLI-Plugin V2 auf Ihrem lokalen System. Weitere Informationen finden Sie im Abschnitt zum Installieren der Activity Tracker Event Routing-CLI.

Melden Sie sich als Nächstes bei IBM Cloud an. Führen Sie den folgenden Befehl aus: ibmcloud login

Route über die Befehlszeilenschnittstelle erstellen

Verwenden Sie den folgenden Befehl, um eine neue Route für ein Activity Tracker Event Routing-Ziel zu erstellen.

ibmcloud atracker route create --name ROUTE_NAME  ( --target-ids TARGETS  [--locations REGIONS] | --rules RULES | --file RULES_DEFINITION_JSON_FILE ) [--output FORMAT]

OK
Route
Name:                    dev-eu-de-route
ID:                      44444444-4444-4444-4444-444444444444
CRN:                     crn:v1:staging:public:atracker:eu-de:a/11111111111111111111111111111111::route:44444444-4444-4444-4444-444444444444
Version:                 0
Rules:                   [locations: [us-south], target_ids: [33333333-3333-3333-3333-333333333333]]
Created:                 2022-02-24T21:10:09.996Z
Updated:                 2022-02-24T21:10:09.996Z

Route über die Befehlszeilenschnittstelle aktualisieren

Verwenden Sie den folgenden Befehl, um eine Route für ein Activity Tracker Event Routing-Ziel zu aktualisieren. Jeder angegebene Wert, der sich von dem Zeitpunkt, zu dem die Route ursprünglich erstellt wurde, unterscheidet, wird auf den im Befehl angegebenen Wert aktualisiert.

ibmcloud atracker route update --route ROUTE [--name ROUTE_NAME] [--force] ( [--target-ids TARGETS]  [--locations REGIONS] | [--rules RULES] | [--file RULES_DEFINITION_JSON_FILE] ) [--output FORMAT] [--output FORMAT]

OK
Route
Name:                    dev-eu-de-route
ID:                      44444444-4444-4444-4444-444444444444
CRN:                     crn:v1:staging:public:atracker:eu-de:a/11111111111111111111111111111111::route:44444444-4444-4444-4444-444444444444
Version:                 1
Rules:                   [locations: [*], target_ids: [55555555-5555-5555-5555-555555555555]]
Created:                 2022-02-24T21:10:09.996Z
Updated:                 2022-02-24T21:13:37.218Z

Route wird über die Befehlszeilenschnittstelle gelöscht

Verwenden Sie diesen Befehl, um eine Activity Tracker Event Routing-Route zu löschen.

ibmcloud atracker route rm --route ROUTE [--force]

Are you sure you want to remove the route with the Route ID 44444444-4444-4444-4444-444444444444? [y/N]> y
OK
Route with route ID 44444444-4444-4444-4444-444444444444 was successfully removed.

FAILED
No route found with route name - 33333333-3333-3333-3333-333333333333

Route über die Befehlszeilenschnittstelle anzeigen

Verwenden Sie diesen Befehl, um Informationen zu einer Activity Tracker Event Routing-Route abzurufen.

ibmcloud atracker route get --route ROUTE [--output FORMAT]

OK
Route
Name:                    dev-eu-de-route-0
ID:                      44444444-4444-4444-4444-444444444444
CRN:                     crn:v1:staging:public:atracker:eu-de:a/11111111111111111111111111111111::route:44444444-4444-4444-4444-444444444444
Version:                 2
Rules:                   [locations: [us-south], target_ids: [55555555-5555-5555-5555-555555555555]]
Created:                 2022-02-24T21:10:09.996Z
Updated:                 2022-02-24T21:15:07.281Z

Alle Routen über die Befehlszeilenschnittstelle auflisten

Verwenden Sie diesen Befehl, um alle konfigurierten Routen für Activity Tracker Event Routing aufzulisten.

ibmcloud atracker route ls [--output FORMAT]

Name                      ID                                     Rules                                              Route Version   API version   CreatedAt                  UpdatedAt
my-global-route           aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa   [[11111111-1111-1111-1111-111111111111],[global]]  5               2             2022-05-04T20:18:00.595Z   2022-05-05T19:04:58.374Z
send-all-to-us-east       bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb   [[22222222-2222-2222-2222-222222222222],[*]]       0               2             2022-05-06T12:02:47.832Z   2022-05-06T12:02:47.832Z

API-Routen und -Aktionen

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

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 mithilfe eines API-Endpunkts im folgenden Format verwalten: https://private.REGION.atracker.cloud.ibm.com.

• Sie können Routen aus dem öffentlichen Netz mithilfe eines API-Endpunkts im folgenden Format verwalten: https://REGION.atracker.cloud.ibm.com.

• Da die Routen globale Konfigurationen sind, können Sie jeden regionalen Endpunkt verwenden, um die Routen für das Konto zu verwalten.

• Sie können die öffentlichen Endpunkte inaktivieren, indem Sie die Kontoeinstellungen aktualisieren. Weitere Informationen finden Sie unter Ziel- und Regionseinstellungen konfigurieren.

Weitere Informationen zu der REST-API finden Sie unter Routen.

API-Voraussetzungen

Führen Sie die folgenden Schritte aus, um API-Aufrufe zum Verwalten von Routen zu erstellen:

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.

Route über die API erstellen

Sie müssen ein Ziel erstellen, bevor Sie eine Route erstellen.

Sie können den folgenden cURL-Befehl verwenden, um eine Route zu erstellen:

curl -X POST  <ENDPOINT>/api/v2/routes   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"  -d '{
    "name": "ROUTE_NAME",
    "rules": [
      {
        "locations": ["LOCATIONS"],
        "target_ids": ["TARGET_ID"]
      }
    ]
  }'

Wo

• <ENDPOINT> ist der API-Endpunkt in der Region, in der Sie eine Route konfigurieren oder verwalten wollen. Weitere Informationen finden Sie unter Endpunkte.

• ROUTE_NAME ist der Name der Route. Die maximale Länge des Namens beträgt 180 Zeichen und darf keines der folgenden Sonderzeichen enthalten:-, ., _, :.

  Schließen Sie keine personenbezogenen Daten in Ressourcennamen ein.

• LOCATIONS ist eine Liste der Standorte, die der Route zugeordnet sind. Geben Sie global an, um globale Ereignisse einzuschließen. Um alle Standorte einzuschließen, geben Sie * an. Wenn Sie neben einer Regel mit einem durch einen * gekennzeichneten Standort noch weitere Regeln haben, leiten die anderen Regeln Ereignisse an die angegebenen Ziele weiter, wobei Ereignisse, die keiner anderen Regel entsprechen, die verbleibenden Ereignisse an das Ziel weiterleiten, das durch die Regel mit dem durch den * gekennzeichneten Standort angegeben ist.

• TARGET_ID ist die GUID des Ziels, das definiert, wohin Prüfereignisse weitergeleitet und wo sie erfasst werden. Dies kann GUIDs von Zielen in anderen Regionen umfassen. Wenn TARGET_ID leer ist, werden alle Ereignisse, die der Regel entsprechen, gelöscht.

Sie können beispielsweise die folgende cURL-Anforderung verwenden, um eine Route zu erstellen, die definiert, wie globale Ereignisse und Ereignisse in der Region 'USA (Süden)' im Konto erfasst und weitergeleitet werden:

curl -X POST   https://private.us-south.atracker.cloud.ibm.com/api/v2/routes   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"  -d '{
    "name": "my-route",
    "rules": [
      {
        "locations": ["us-south", "global"],
        "target_ids": ["22222222-2222-2222-2222-222222222222"]
      }
    ]
  }'

In der Antwort erhalten Sie Informationen zu der Route wie id, die die GUID der Route angibt, und die crn, die die CRN der Route angibt.

Route über die API aktualisieren

Wenn Sie eine Route aktualisieren, müssen Sie die Routeninformationen in den Datenabschnitt der Anforderung einschließen.

• Sie müssen alle Felder übergeben.
• Aktualisieren Sie die Felder, die geändert werden müssen.

Sie können den folgenden cURL-Befehl verwenden, um eine Route zu aktualisieren:

curl -X PUT  <ENDPOINT>/api/v2/routes/<ROUTE_ID>   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"  -d '{
    "name": "ROUTE_NAME",
    "rules": [
      {
        "locations": ["LOCATIONS"],
        "target_ids": ["TARGET_ID"]
      }
    ]
  }'

Wo

• <ENDPOINT> ist der API-Endpunkt in der Region, in der Sie eine Route konfigurieren oder verwalten wollen. Weitere Informationen finden Sie unter Endpunkte.

• <ROUTE_ID> ist die ID der zu aktualisierenden Route.

• ROUTE_NAME ist der Name der Route. Die maximale Länge des Namens beträgt 180 Zeichen und darf keines der folgenden Sonderzeichen enthalten:-, ., _, :.

  Schließen Sie keine personenbezogenen Daten in Ressourcennamen ein.

• LOCATIONS ist eine Liste der Standorte, die der Route zugeordnet sind. Geben Sie global an, um globale Ereignisse einzuschließen. Um alle Standorte einzuschließen, geben Sie * an. Wenn Sie neben einer Regel mit einem durch einen * gekennzeichneten Standort noch weitere Regeln haben, leiten die anderen Regeln Ereignisse an die angegebenen Ziele weiter, wobei Ereignisse, die keiner anderen Regel entsprechen, die verbleibenden Ereignisse an das Ziel weiterleiten, das durch die Regel mit dem durch den * gekennzeichneten Standort angegeben ist.

• TARGET_ID ist die GUID des Ziels, das definiert, wohin Prüfereignisse weitergeleitet und wo sie erfasst werden. Dies kann GUIDs von Zielen in anderen Regionen umfassen. Wenn TARGET_ID leer ist, werden alle Ereignisse, die der Regel entsprechen, gelöscht.

Sie können beispielsweise die folgende cURL-Anfrage verwenden, um eine Route zu aktualisieren, die definiert, wie globale Ereignisse und Ereignisse in den Regionen 'USA (Süden)' und 'USA (Osten)' im Konto erfasst und weitergeleitet werden:

curl -X PUT https://private.us-south.atracker.cloud.ibm.com/api/v2/routes/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"  -d '{
    "name": "my-route",
    "rules": [
      {
        "locations": ["us-south", "global", "us-east],
        "target_ids": ["22222222-2222-2222-2222-222222222222"]
      }
    ]
  }'

Route über die API löschen

Mit dem folgenden cURL-Befehl können Sie eine Route löschen:

curl -X DELETE   <ENDPOINT>/api/v2/routes/<ROUTE_ID>   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"

Wo

• <ENDPOINT> ist der API-Endpunkt in der Region, in der Sie eine Route konfigurieren oder verwalten wollen. Weitere Informationen finden Sie unter Endpunkte.
• <ROUTE_ID> ist die ID der zu löschenden Route.

Sie können beispielsweise die folgende cURL-Anforderung ausführen, um die Route mit der ID aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa zu löschen:

curl -X DELETE  https://private.us-south.atracker.cloud.ibm.com/api/v2/routes/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"

Route über die API anzeigen

Sie können den folgenden cURL-Befehl zum Anzeigen einer Route verwenden:

curl -X GET   <ENDPOINT>/api/v2/routes/<ROUTE_ID>   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"

Wo

• <ENDPOINT> ist der API-Endpunkt in der Region, in der Sie eine Route konfigurieren oder verwalten wollen. Weitere Informationen finden Sie unter Endpunkte.
• <ROUTE_ID> ist die ID der abzurufenden Route.

Sie können beispielsweise die folgende cURL-Anforderung ausführen, um Informationen zu einer Route mit der ID aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa abzurufen:

curl -X GET   https://private.us-south.atracker.cloud.ibm.com/api/v2/routes/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa    -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"

Alle Routen in einer Region mithilfe der API auflisten

Sie können den folgenden cURL-Befehl verwenden, um alle Routen anzuzeigen:

curl -X GET   <ENDPOINT>/api/v2/routes   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"

Wo

• <ENDPOINT> ist der API-Endpunkt in der Region, in der Sie eine Route konfigurieren oder verwalten wollen. Weitere Informationen finden Sie unter Endpunkte.

Sie können beispielsweise die folgende cURL-Anforderung ausführen, um Informationen zu den in der Region 'USA (Süden)' definierten Routen abzurufen:

curl -X GET   https://private.us-south.atracker.cloud.ibm.com/api/v2/routes    -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"

HTTP-Antwortcodes

Wenn Sie die Activity Tracker Event 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:

Route über die Benutzerschnittstelle erstellen

1. Melden Sie sich bei Ihrem IBM Cloud-Konto an.
2. Klicken Sie auf das Menüsymbol > Beobachtbarkeit.
3. Wählen Sie „ Aktivitätsaufzeichnung “ aus.
4. Wählen Sie Routen aus.
5. Klicken Sie auf „Erstellen“, um die Erstellungsseite zu öffnen.
6. Geben Sie einen aussagekräftigen Namen für die Route ein.
7. Ändern Sie in Routing-Regeln Regel 1:
   • Prüfereignisse senden von: Wählen Sie die Prüfereignispositionen aus, die dieser Regel entsprechen.
   • Zielziele: Wählen Sie ein Ziel aus, das dieser Regel zugeordnet wird. Klicken Sie auf Ziel hinzufügen, um weitere Ziele zur Regel hinzuzufügen.
8. Klicken Sie auf Regel hinzufügen, um der Route zusätzliche Regeln hinzuzufügen.
   • Die Reihenfolge der Routenregeln wirkt sich auf das Routing-Verhalten aus. Regeln werden der Reihe nach verarbeitet, und sobald eine Regel erfüllt ist, werden die nachfolgenden Regeln nicht mehr verarbeitet.
9. Jede Regel verfügt über einen Auf-und Abwärtspfeil, mit dem Sie die Regelreihenfolge ändern können.
10. Jede Regel verfügt über eine Schaltfläche Entfernen, über die Sie eine Regel aus einer Route löschen können.
11. Überprüfen Sie die Routendefinition, um sicherzustellen, dass die Reihenfolge der Regeln wie beabsichtigt ist.
12. Klicken Sie auf Erstellen.

Eine Route über die Benutzeroberfläche aktualisieren

1. Melden Sie sich bei Ihrem IBM Cloud-Konto an.
2. Klicken Sie auf das Menüsymbol > Beobachtbarkeit.
3. Wählen Sie „ Aktivitätsaufzeichnung “ aus.
4. Wählen Sie Routen aus.
5. Legen Sie fest, welche Route aktualisiert werden soll, und klicken Sie auf das Symbol .
6. Klicken Sie auf Umbenennen, um die Route umzubenennen.
7. Klicken Sie auf Bearbeiten, um die Routenregeln zu aktualisieren.
8. Bearbeiten Sie bei Bedarf die vorhandenen Regeln:
   • Prüfereignisse senden von: Wählen Sie die Prüfereignispositionen aus, die dieser Regel entsprechen.
   • Zielziele: Wählen Sie ein Ziel aus, das dieser Regel zugeordnet wird. Klicken Sie auf Ziel hinzufügen, um weitere Ziele zur Regel hinzuzufügen.
9. Klicken Sie auf Regel hinzufügen, um der Route zusätzliche Regeln hinzuzufügen.
   • Die Reihenfolge der Routenregeln wirkt sich auf das Routing-Verhalten aus. Regeln werden der Reihe nach verarbeitet, und sobald eine Regel erfüllt ist, werden die nachfolgenden Regeln nicht mehr verarbeitet.
10. Jede Regel verfügt über einen Auf-und Abwärtspfeil, mit dem Sie die Regelreihenfolge ändern können.
11. Jede Regel verfügt über eine Schaltfläche Entfernen, über die Sie eine Regel aus einer Route löschen können.
12. Klicken Sie auf Aktualisieren, um Änderungen an Ihrer Route vorzunehmen.

Anzeigen einer Route über die Benutzeroberfläche

1. Melden Sie sich bei Ihrem IBM Cloud-Konto an.
2. Klicken Sie auf das Menüsymbol > Beobachtbarkeit.
3. Wählen Sie „ Aktivitätsaufzeichnung “ aus.
4. Wählen Sie Routen aus.
5. Die Routentabelle ist nach Erstellungsdatum sortiert. Die Reihenfolge der Routen hat keine Auswirkungen auf das Routing-Verhalten.
6. Jeder Routenblock zeigt den Routennamen und die Regeln an.
7. Auf der Seite "Routen" wird auch Routenanleitung mit zusätzlichen Informationen zur Konfiguration des Routing angezeigt.

Route über die Benutzerschnittstelle löschen

1. Melden Sie sich bei Ihrem IBM Cloud-Konto an.
2. Klicken Sie auf das Menüsymbol > Beobachtbarkeit.
3. Wählen Sie „ Aktivitätsaufzeichnung “ aus.
4. Wählen Sie Routen aus.
5. Legen Sie fest, welche Route aktualisiert werden soll, und klicken Sie auf das Symbol .
6. Klicken Sie auf Löschen, um die gesamte Route zu löschen. Sie müssen den Namen der Route eingeben, bevor die Route gelöscht wird.