Kontoeinstellungen konfigurieren

Sie können IBM Cloud Logs Routing Kontoeinstellungen konfigurieren, um festzulegen, wo und wie Plattformprotokolle in Ihrem Konto gesammelt, weitergeleitet und verwaltet werden. Sie können dies über die Benutzeroberfläche oder über die CLI, die REST-API V3 oder Terraform-Skripte tun.

Bevor Sie öffentliche Endpunkte durch Festlegen von --private-api-endpoint-only TRUE inaktivieren, stellen Sie sicher, dass Ihr Konto Zugriff auf den privaten Endpunkt hat. Sie können dies tun, indem Sie den Befehl ibmcloud account showausführen. Wenn VRF Enabled auf true gesetzt ist und Service Endpoint Enabled auf true gesetzt ist, haben Sie Zugriff auf den privaten Endpunkt. Wenn Sie keinen Zugriff auf den privaten Endpunkt haben, können Sie den öffentlichen Endpunkt nicht erneut aktivieren, da der private Endpoint-Zugriff erforderlich ist, um den öffentlichen Endpunkt erneut zu aktivieren.

Weitere Informationen finden Sie unter Über Kontoeinstellungen.

IAM-Berechtigungen

Stellen Sie sicher, dass Sie die die richtigen IAM-Berechtigungen für die Konfiguration der Einstellungen von IBM Cloud Logs Routing.

Abrufen von Details zu den Kontoeinstellungen über die Benutzeroberfläche

Führen Sie die folgenden Schritte aus, um die Kontoeinstellungen für IBM Cloud Logs Routing über die Benutzeroberfläche anzuzeigen:

Melden Sie sich bei Ihrem IBM Cloud Konto an.
Klicken Sie auf das Menüsymbol > Beobachtbarkeit.
Klicken Sie auf Protokollierung > Routing.
Klicken Sie auf die Registerkarte Einstellungen.

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

Standort der Metadaten: Zeigt die primäre Metadatenregion und die Backup-Metadatenregion an.
Zulässige Zielregionen. Zeigt die Zielregionen an, an die Plattformprotokolle gesendet werden können.
Standard-Ziele: Zeigt die konfigurierten Standardziele an.
Öffentliche Endpunkte: Zeigt an, ob öffentliche Endpunkte aktiviert sind. Wenn diese Funktion deaktiviert ist, kann die Benutzeroberfläche IBM Cloud Logs Routing nicht aufgerufen werden.
Berichte: Zeigt die Konfigurationen im JSON-Format an.

Aktualisieren der Kontoeinstellungen über die Benutzeroberfläche

Melden Sie sich bei Ihrem IBM Cloud Konto an.
Klicken Sie auf das Menüsymbol > Beobachtbarkeit.
Klicken Sie auf Protokollierung >Routing.
Klicken Sie auf die Registerkarte Einstellungen.
Klicken Sie auf Bearbeiten neben der zu ändernden Einstellung. Sie können die folgenden Einstellungen ändern:

Metadaten-Speicherort: Wählen Sie die gewünschte primäre Metadatenregion und die Backup-Metadatenregion.
Erlaubte Zielregionen: Wählen Sie die Region aus, in der Ziele erstellt werden können. Wenn keine Regionen ausgewählt sind, können alle Regionen Plattformprotokolle empfangen.
Standard-Ziele: Wählen Sie das Ziel aus, das standardmäßig verwendet wird, wenn es keine Routing-Regeln gibt oder diese nicht erfüllt sind.

CLI-Voraussetzungen

Bevor Sie die CLI zur Verwaltung der IBM Cloud Logs Routing Kontoeinstellungen verwenden, installieren Sie die IBM Cloud Logs Routing CLI.

Überprüfen Sie, ob Sie über IAM-Berechtigungen zum Lesen, Aktualisieren oder für beide Einstellungen des Kontos IBM Cloud Logs Routing verfügen.

Abrufen von Details zu den Kontoeinstellungen über die CLI

Verwenden Sie diesen Befehl, um die Einstellungen für die IBM Cloud Logs Routing Kontokonfigurationen abzurufen.

ibmcloud logs-router setting get [--output FORMAT]

Befehlsoptionen

--output FORMAT: Wenn JSON angegeben ist, wird die Ausgabe im JSON-Format zurückgegeben. Wenn JSON nicht angegeben ist, wird die Ausgabe in einem Tabellenformat zurückgegeben.
help | --help | -h: Hiermit können Sie Optionen auflisten, die für den Befehl verfügbar sind.

Beispiel

Nachfolgend ein Beispiel, bei dem keine Standard- oder zulässigen Ziele festgelegt wurden.

Default Targets             -
Permitted Target Regions    -
Primary Metadata Region
Backup Metadata Region
Private Api Endpoint Only   false
Api Version                 1

Aktualisieren der Kontoeinstellungen über die CLI

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

ibmcloud logs-router setting update [--default-targets DEFAULT-TARGETS | @DEFAULT-TARGETS-FILE] [--permitted-target-regions PERMITTED-TARGET-REGIONS] [--primary-metadata-region PRIMARY-METADATA-REGION] [--backup-metadata-region BACKUP-METADATA-REGION] [--private-api-endpoint-only=PRIVATE-API-ENDPOINT-ONLY] [--output FORMAT] [--force]

Befehlsoptionen

primary-metadata-region

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

Maximal zulässige Länge: 256 Zeichen. Die Mindestlänge beträgt 3 Zeichen.

backup-metadata-region

Geben Sie die REGION an, in der die mit den Routen- und Zieldefinitionen verbundenen Metadaten als Backup gespeichert werden.

Maximal zulässige Länge: 256 Zeichen. Die Mindestlänge beträgt 3 Zeichen.

private-api-endpoint-only

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

default-targets

Eine Liste der Ziel-IDs. Wenn keine Routingregeln dazu führen, dass Plattformprotokolle an andere Ziele gesendet werden, erhalten diese Ziele die Plattformprotokolle. TARGETS ist eine durch Kommas getrennte Liste von Ziel-IDs.

Die maximale Länge beträgt 2 Einträge. Die Mindestlänge beträgt 0 Elemente.

permitted-target-regions

Die Liste der Regionen, die zum Definieren eines Ziels verwendet werden kann. REGIONS ist eine durch Kommas getrennte Liste von Regionen.

Die maximale Länge beträgt 16 Einträge. Die Mindestlänge beträgt 0 Elemente.

--output FORMAT

Bei Angabe von JSON wird die Ausgabe im JSON-Format zurückgegeben. Wenn JSON nicht angegeben ist, wird die Ausgabe in einem Tabellenformat zurückgegeben.

help | --help | -h

Hiermit können Sie Optionen auflisten, die für den Befehl verfügbar sind.

Wenn die Aktualisierung erfolgreich ist, werden die aktuellen Einstellungen angezeigt.

API-Voraussetzungen

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

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

Abrufen von Details zu den Kontoeinstellungen über die API

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

curl -X GET  ENDPOINT/api/v3/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 zum Beispiel die folgende Anfrage cURL verwenden, um die Informationen zu den Kontoeinstellungen abzurufen:

curl -X GET   https://api.<region>.logs-router.cloud.ibm.com/v3/settings   -H "Authorization:  $ACCESS_TOKEN"

Eine Antwort ähnlich der folgenden wird zurückgegeben:

{
  "default_targets":[],
  "permitted_target_regions":[],
  "primary_metadata_region":"",
  "backup_metadata_region":"",
  "private_api_endpoint_only":false,
  "api_version":1
}

Dabei gilt:

default_targets: Eine Liste der Ziel-IDs. Wenn keine Routingregeln dazu führen, dass Plattformprotokolle an andere Ziele gesendet werden, erhalten diese Ziele die Plattformprotokolle.
permitted_target_regions: Die Liste der Regionen, die zum Definieren eines Ziels verwendet werden kann. Es sind maximal zwei Zielregionen zulässig.
primary_metadata_region: Die Region, in der die Metadaten, die den Routen- und Zieldefinitionen zugeordnet sind, gespeichert sind.
backup_metadata_region: Ist der Bereich, in dem die mit den Routen- und Zieldefinitionen verbundenen Metadaten als Backup 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.
api_version: Ist die für dieses Konto konfigurierte Version der API.

Aktualisieren der Kontoeinstellungen über die API

Beachten Sie bei der Aktualisierung der Einstellungen die folgenden Informationen:

Sie müssen die Informationen zu den Einstellungen in den Datenteil der Anfrage aufnehmen.
Sie müssen die Daten übergeben, die für jede Einstellung konfiguriert sind.

Daten, die konfiguriert und nicht in einer Aktualisierungsanforderung enthalten sind, werden gelöscht.
Aktualisieren Sie die Daten für die Felder, die geändert werden müssen.
Eine Änderung der API-Version ist nur im Rahmen des Migrationsprozesses von V1 auf V3 zulässig. Siehe Übergang von v1 zu v3.

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

curl -X PATCH   https://api.<region>.logs-router.cloud.ibm.com/v3/settings
-H "Authorization: Bearer <IAM_TOKEN>"
-H 'accept: application/json'
-d '{
    "default_targets": [
      {
        "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      }
    ],
    "permitted_target_regions": ["us-south", "us-east"],
    "primary_metadata_region": "us-south",
    "backup_metadata_region": "us-east",
    "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 Routingregeln dazu führen, dass Plattformprotokolle an andere Ziele gesendet werden, erhalten diese Ziele die Plattformprotokolle.
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.
primary_metadata_region: Die Region, in der die Metadaten, die den Routen- und Zieldefinitionen zugeordnet sind, gespeichert sind.
backup_metadata_region: Ist der Bereich, in dem die mit den Routen- und Zieldefinitionen verbundenen Metadaten zu Sicherungszwecken gespeichert werden.
private_api_endpoint_only: Gibt an, ob ein privater Endpunkt verwendet werden kann oder nicht. Ist true festgelegt, kann nur ein privater Endpunkt verwendet werden.