CLI-Voraussetzungen

Bevor Sie die Befehlszeilenschnittstelle für die Verwaltung von Activity Tracker Event Routing-Kontoeinstellungen verwenden, installieren Sie die IBM Cloud Activity Tracker Event Routing-CLI.

Überprüfen Sie, ob Sie über IAM-Berechtigungen zum Lesen oder Aktualisieren der Activity Tracker Event Routing Kontoeinstellungen verfügen.

Kontoeinstellungen über die Befehlszeilenschnittstelle (CLI) abrufen

Verwenden Sie diesen Befehl, um die Einstellungen für die IBM Cloud Activity Tracker Event Routing Kontokonfigurationen zu erhalten.

ibmcloud atracker setting get [--output FORMAT]

Atracker settings
Metadata region primary:     us-south
Metadata region backup:      us-east
Default targets:             []
Permitted target regions:    []
Private api endpoint only:   false
API version:                 2

Einstellungen über die Befehlszeilenschnittstelle (CLI) aktualisieren

Verwenden Sie diesen Befehl, um aktuelle Kontoeinstellungen wie die Standardziele, zulässige Zielregionen und die primäre Metadatenregion zu ändern.

ibmcloud atracker setting update [--metadata-region-primary REGION] [--metadata-region-backup REGION] [--default-targets TARGET] [--permitted-target-regions REGIONS] [--private-api-endpoint-only ( TRUE | FALSE )] [--output FORMAT] [--force]

API-Einstellungen und -Aktionen

In der folgenden Tabelle sind die Aktionen aufgeführt, die zur Verwaltung von Einstellungen ausgeführt werden können:

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

• Standardmäßig können Sie Einstellungen aus dem privaten Netz verwalten. Sie müssen einen API-Endpunkt mit dem folgenden Format verwenden: https://private.<region>.atracker.cloud.ibm.com

• Sie können auch öffentliche Endpunkte in einer Region aktivieren, um Einstellungen zu verwalten. Weitere Informationen finden Sie unter KI-Modelle verwalten.

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

API-Voraussetzungen

Führen Sie die folgenden Schritte aus, um API-Aufrufe zum Verwalten von Einstellungen durchzuführen:

1. Rufen Sie ein IAM-Zugriffstoken ab. Weitere Informationen finden Sie unter Abrufen von IAM-Zugriffstokens.
2. Ermitteln Sie den API-Endpunkt in der Region, in der Sie Einstellungen konfigurieren oder verwalten möchten. Weitere Informationen finden Sie unter Endpunkte.

Einstellungen über die API abrufen

Mit dem folgenden cURL-Befehl können Sie Informationen zu vorhandenen Einstellungen abrufen:

curl -X GET  ENDPOINT/api/v2/settings   -H "Authorization:  $ACCESS_TOKEN"

Dabei gilt:

ENDPOINT

Der API-Endpunkt in der Region, in der Sie ein Ziel konfigurieren oder verwalten möchten. Weitere Informationen finden Sie unter Endpunkte.

Sie können beispielsweise die folgenden cURL-Anforderung verwenden, um Einstellungsinformationen für die Region 'USA (Süden)' abzurufen:

curl -X GET   https://private.us-south.atracker.cloud.ibm.com/api/v2/settings   -H "Authorization:  $ACCESS_TOKEN"

Eine Antwort ähnlich der folgenden wird zurückgegeben:

{
 "default_targets": ["50375218-0000-4234-bbb4-171bebab8408", "c7519d8a-5f97-498b-0000-8542f60955cd"],
 "permitted_target_regions": ["us-south", "us-east"],
 "metadata_region_primary": "us-south",
 "metadata_region_backup": "eu-de",
 "private_api_endpoint_only": false
}

Dabei gilt:

default_targets

Eine Liste der Ziel-IDs. Wenn keine Routing-Regeln dafür sorgen, dass Ereignisse an andere Ziele gesendet werden, empfangen diese Ziele die Ereignisse.

permitted_target_regions

Die Liste der Regionen, die zum Definieren eines Ziels verwendet werden kann. Es sind maximal zwei Zielregionen zulässig.

metadata_region_primary

Die Region, in der die Metadaten, die den Routen- und Zieldefinitionen zugeordnet sind, gespeichert sind.

metadata_region_backup

Ist der Bereich, in dem die mit den Routen- und Zieldefinitionen verbundenen Metadaten als Sicherungsort gespeichert werden.

private_api_endpoint_only

Gibt an, ob ein privater Endpunkt verwendet werden kann. Ist true festgelegt, kann nur ein privater Endpunkt verwendet werden.

Einstellungen über die API aktualisieren

Wenn Sie Einstellungen aktualisieren, müssen Sie die Einstellungsinformationen in den Datenabschnitt der Anforderung einschließen.

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

Mit dem folgenden cURL-Befehl können Sie Einstellungen aktualisieren:

curl -X PUT  <ENDPOINT>/api/v2/settings
-H "Authorization:  $ACCESS_TOKEN"
-H "content-type: application/json"
-d '{
   "default_targets": ["IDs"],
   "permitted_target_regions": ["REGIONS"],
   "metadata_region_primary": "REGION",
   "metadata_region_backup": "REGION",
   "private_api_endpoint_only": false
}'

Dabei gilt:

ENDPOINT

Der API-Endpunkt in der Region, in der Sie ein Ziel konfigurieren oder verwalten möchten. Weitere Informationen finden Sie unter Endpunkte.

default_targets

Eine Liste der Ziel-IDs. Wenn keine Routing-Regeln dafür sorgen, dass Ereignisse an andere Ziele gesendet werden, empfangen diese Ziele die Ereignisse.

permitted_target_regions

Die Liste der Regionen, die zum Definieren eines Ziels verwendet werden kann. Es können maximal zwei zulässige Zielregionen angegeben werden.

metadata_region_primary

Die Region, in der die Metadaten, die den Routen- und Zieldefinitionen zugeordnet sind, gespeichert sind.

metadata_region_backup

Ist der Bereich, in dem die mit den Routen- und Zieldefinitionen verbundenen Metadaten als Sicherungsort gespeichert werden.

private_api_endpoint_only

Gibt an, ob ein privater Endpunkt verwendet werden kann. Ist true festgelegt, kann nur ein privater Endpunkt verwendet werden.

HTTP-Antwortcodes

Wenn Sie die IBM Cloud 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:

Abrufen von Kontoeinstellungen ü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 Activity Tracker aus.
4. Wählen Sie Routing aus.
5. Wählen Sie Einstellungen.

Auf dieser Seite können Sie die folgenden Einstellungen anzeigen:

• Metadatenposition: Zeigt die primäre Metadatenregion und die Backup-Metadatenregion an.
• Zulässige Zielregionen. Zeigt die Zielregionen an, an die Ereignisse gesendet werden können
• Standardziele: Zeigt die konfigurierten Standardziele an.
• Öffentliche Endpunkte: Zeigt an, ob öffentliche Endpunkte aktiviert sind. Wenn diese Option inaktiviert ist, kann nicht auf die Benutzerschnittstelle von Activity Tracker Event Routing zugegriffen werden.
• Berichte: Zeigt die Konfiguration im JSON-Format an.

Aktualisieren von Einstellungen ü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 Activity Tracker aus.
4. Wählen Sie Routing aus.
5. Wählen Sie Einstellungen.

Klicken Sie neben der Einstellung, die geändert werden soll, auf Bearbeiten. Sie können die folgenden Einstellungen ändern:

• Metadatenposition: Wählen Sie Ihre gewünschte primäre Metadatenregion und Sicherungsmetadatenregion aus.
• Zulässige Zielregionen: Wählen Sie die Region aus, in der Ziele erstellt werden können. Wenn keine Regionen ausgewählt sind, können alle Regionen Ereignisse empfangen.
• Standardziele: Wählen Sie das Ziel aus, das standardmäßig verwendet wird, wenn Routing-Regeln nicht vorhanden sind oder nicht übereinstimmen.