Event Streams-CLI - Referenz

Wenn Sie Informationen zur Installation der Befehlszeilenschnittstelle für Event Streamsbenötigen, lesen Sie den AbschnittIn: Einführung in die Event Streams -CLI.

Änderungsprotokoll

Changelog für das Event Streams CLI-Plugin
Version Freigabedatum Änderungen
v1.0
  1. Mai 2019
  • Erstes Release der Befehlszeilenschnittstelle von Event Streams.
v1.0.1
  1. Mai 2019
 -Verbesserte Fehlernachricht, wenn Sie den Befehl ohne init ausführen.
-Liste sortierter Instanzen während init.
-Übersetzungsaktualisierung.
v2.0
  1. August 2019

-init: Die Serviceschlüsselanforderung wurde entfernt.

  • Der Befehl 'group-delete' wurde hinzugefügt. Übersetzungen des Hilfetextes aktualisiert.
v2.1
  1. Juni 2020
  • init: angezeigte Bereitstellungsparameter für Unternehmensinstanz.
  • Übersetzungsaktualisierung.
v2.1.1
  1. Juli 2020
  • Ersetzt whitelist mit 'allowlist`.
  • Farbkonfiguration korrigiert.
  • Aktualisierung der Übersetzung.
v2.2.0
  1. August 2020
  • Unterstützung für die Spiegelungsfunktion hinzugefügt.
v2.2.1
  1. August 2020
  • init: Die Anzeige der IP allowlist wurde verbessert.
v2.3
  1. November 2020
  • Unterstützung für die Konfiguration der Nachrichtenprüfung für das Thema hinzugefügt.
  • init: Verschlüsselungsschlüssel anzeigen, wenn der Parameter kms_key_crn in der Bereitstellung angegeben ist.
v2.3.2
  1. Mai 2022
  • Unterstützung für Mac OS X M1/ARM hinzugefügt.
  • init: Anzeige von Object Storage Bucket, wenn der Parameter cos_bucket_crn in der Provisionierung angegeben ist.
v2.4.0
  1. Februar 2023
 -Hinzugefügte Version Kafka zu ibmcloud es cluster.
-Aktualisiert Rufen Sie 1.9.6auf.
v2.4.1
  1. Dezember 2023
 -Hinzugefügte Befehle mirroring-active-topics und help.
v2.5.0
  1. Dezember 2023
 -Hinzugefügte schema-import-Befehle.
v2.6.0
  1. August 2024
  • schemas, schema-create, schema, schema-update, schema-delete, schema-versions, schema-version-create hinzugefügt, schema-version, schema-version-update, schema-version-delete, schema-compatibility-rule-create, schema-compatibility-rule, schema-compatibility-rule-update, und schema-compatibility-rule-delete Befehle.
v2.6.1 01 Nov 2024
  • Behebung von Schwachstellen.
v2.6.2
  1. Februar 2025
  • Behebung von Schwachstellen.
v2.7.0
  1. Februar 2025
  • Vom Kafka-Server zurückgegebene Fehlermeldungen werden übersetzt.
  • Fix broker-config Druckeinstellungen doppelt.
v2.7.1
  1. Mai 2025
  • Behebung von Schwachstellen.
v2.7.3
  1. April 2026
  • Behebung von Schwachstellen.
  • Geringfügige Änderung bei der Behandlung ungültiger Parameter. Wenn der optionale Parameter nicht angegeben wird, werden ungültige Parameter möglicherweise ignoriert, anstatt dass ein Fehler zurückgegeben wird.

ibmcloud es init

Initialisieren Sie das Event Streams -Plug-in.

ibmcloud es init [-i|--instance-name INSTANCE_NAME] [-a|--api-url API_ENDPOINT_URL]

Voraussetzungen: Keine

Befehlsoptionen:

--instance-name wert, -i wert (optional)
Name der Event Streams -Instanz.
--api-url wert, -a wert (optional)
Die Kafka-Administrator-URL der Event Streams-Instanz.

ibmcloud es broker

Anzeige der Details eines bestimmten Brokers.

ibmcloud es broker [--broker] ID [--json]

Voraussetzungen: Keine

Befehlsoptionen:

--broker wert, -b wert
Die Broker-ID. Sie können sie mit oder ohne vorangestelltem Flag "--broker" angeben.
--json (optional)
Als Ausgabeformat wird JSON verwendet.

ibmcloud es broker-config

Zeigt die Konfiguration eines Brokers an.

ibmcloud es broker-config [--broker] ID [--filter FILTER] [--verbose] [--json]

Voraussetzungen: Keine

Befehlsoptionen:

--broker wert, -b wert
Die Broker-ID. Sie können sie mit oder ohne vorangestelltem Flag "--broker" angeben.
--filter wert, -f wert (optional)
Filtern Sie die Konfigurationsliste, indem Sie Platzhalterzeichen (*) oder einen regulären Ausdruck mit Schrägstrichen (/) als Trennzeichen verwenden.
--verbose, -v (optional)
Ausführliche Konfigurationsinformationen anzeigen.
--json (optional)
Als Ausgabeformat wird JSON verwendet.

ibmcloud es cluster

Zeigen Sie die Details des Clusters an, einschließlich der Angaben zu allen Brokern und der Kafka.

ibmcloud es cluster [--json]

Voraussetzungen: Keine

Befehlsoptionen:

--json (optional)
Als Ausgabeformat wird JSON verwendet.

ibmcloud es topic

Zeigt die Details eines Topics an.

ibmcloud es topic [--name] TOPIC_NAME [--json]

Voraussetzungen: Keine

Befehlsoptionen:

--name wert, -n wert
Themaname.
--json (optional)
Als Ausgabeformat wird JSON verwendet.

ibmcloud es topic-create

Neues Topic erstellen.

ibmcloud es topic-create [--name] TOPIC_NAME [--partitions PARTITIONS] [--config KEY=VALUE[;KEY=VALUE]* ]*

Voraussetzungen: Keine

Befehlsoptionen:

--name wert, -n wert

Themaname.

--partitions wert, -p wert

Legt die Anzahl der Partitionen für das Topic fest.

--config SCHLÜSSEL=WERT, -c SCHLÜSSEL=WERT (optional)

Legt als Paar mit dem Format SCHLÜSSEL=WERT eine Konfigurationsoption für das Topic fest.

Sie können mehrere Optionen "--config" angeben. Jede Option "--config" kann eine durch Semikolons begrenzte Liste von Zuordnungen angeben. Die folgende Liste enthält gültige Konfigurationsschlüssel:

  • cleanup.policy
  • retention.ms
  • retention.bytes
  • segment.bytes
  • segment.ms
  • segment.index.bytes

ibmcloud es topic-delete

Topic löschen.

ibmcloud es topic-delete [--name] TOPIC_NAME [--force]

Voraussetzungen: Keine

Befehlsoptionen:

--name wert, -n wert
Themaname.
--force, -f (optional)
Löschen ohne Bestätigung.

ibmcloud es topic-delete-records

Löscht Datensätze aus einem Topic für einen bestimmten Offset.

ibmcloud es topic-delete-records [--name] TOPIC_NAME [--partition-offset PARTITION:OFFSET[;PARTITION:OFFSET]* ]* [--force]

Voraussetzungen: Keine

Befehlsoptionen:

--name wert, -n wert
Themaname.
--partition-offset PARTITION:OFFSET, -p PARTITION:OFFSET
Die Partition und der Offset für das Löschen der Datensätze im Format PARTITION:OFFSET.
Sie können mehrere Optionen "--partition-offset" oder mehrere Paare im Format PARTITION:OFFSET angeben, die mit Semikolons voneinander abgegrenzt und in Anführungszeichen eingeschlossen sind: 'PARTITION1:OFFSET1;PARTITION2:OFFSET2;PARTITION3:OFFSET3'.
--force, -f (optional)
Datensätze ohne Bestätigung löschen.

ibmcloud es topic-partitions-set

Legt die Partitionen für ein Topic fest.

ibmcloud es topic-partitions-set [--name] TOPIC_NAME --partitions PARTITIONS

Voraussetzungen: Keine

Befehlsoptionen:

--name wert, -n wert
Themaname.
--partitions wert, -p wert
Legt die Anzahl der Partitionen für das Topic fest.

ibmcloud es topic-update

Aktualisiert die Konfiguration für ein Topic.

ibmcloud es topic-update [--name] TOPIC_NAME --config KEY[=VALUE][;KEY[=VALUE]]* [--default]

Voraussetzungen: Keine

Befehlsoptionen:

--name wert, -n wert

Themaname.

--config KEY[=VALUE], -c KEY[=VALUE]

Legen Sie eine Konfigurationsoption für das Thema als KEY[=VALUE]-Paar fest.

Wenn VALUE nicht angegeben ist, muss das Flag '--default' angegeben werden, um das Zurücksetzen des Konfigurationswerts auf den Standardwert anzugeben. Es können mehrere '--config' Optionen angegeben werden. Jede Option "--config" kann eine durch Semikolons begrenzte Liste von Zuordnungen angeben. Die folgende Liste enthält gültige Konfigurationsschlüssel:

  • cleanup.policy
  • retention.ms
  • retention.bytes
  • segment.bytes
  • segment.ms
  • segment.index.bytes
--default, -d (optional)

Setzen Sie jeden Konfigurationsparameter, der mit '--config' angegeben wurde, auf seinen Standardwert zurück.

ibmcloud es topics

Listet Topics auf.

ibmcloud es topics [--filter FILTER] [--json]

Voraussetzungen: Keine

Befehlsoptionen:

--filter wert, -f wert (optional)
Themaname.
--json (optional)
Ausgabe im JSON-Format. Es werden maximal 1000 Topics zurückgegeben.

ibmcloud es group

Zeigt die Details einer Consumergruppe an.

ibmcloud es group [--group] GROUP_ID [--json]

>Voraussetzungen: Keine

Befehlsoptionen:

--group wert, -g wert
Consumergruppen-ID.
--json (optional)
Ausgabe im JSON-Format.

ibmcloud es group-reset

Setzt die Offsets für eine Consumergruppe zurück.

ibmcloud es group-reset [--group] GROUP_ID [--topic TOPIC_NAME] [--all-topics] --mode MODE --value VALUE [--dry-run] [--execute] [--json]

Voraussetzungen: Keine

Befehlsoptionen:

--group wert, -g wert
Konsumentengruppen-ID
--topic wert, -t wert
Themaname. Der Befehl wird ausschließlich auf dieses Topic angewendet. Übergehen, wenn Flag '-- all-topics' angegeben wurde.
--all-topics, -a
Der Befehl wird auf alle Topics angewendet, die der Gruppe zugeordnet sind. Übergehen, wenn das Flag '-- topic' angegeben wurde.
--mode wert, -m wert
Einer der folgenden Werte: 'latest', 'latest' oder 'datetime'.
--value wert, -v wert
Der auf "--mode" basierende Wert für das Zurücksetzen von Offsets. Lassen Sie diesen Parameter für "earliest" und "latest" weg. 'datetime': Verwenden Sie 'YYYY-MM-DDTHH:mm:SS.sss[±hh:mm|Z]'.
--dry-run (optional)
Zeigt die Ergebnisse an und implementiert die Änderungen nicht.
--execute (optional)
Nimmt die Änderungen an den Offsets vor.
--json (optional)
Ausgabe im JSON-Format.

ibmcloud es groups

Listet Consumergruppen auf.

ibmcloud es groups [--filter FILTER] [--json]

Voraussetzungen: Keine

Befehlsoptionen:

--filter wert, -f wert (optional)
Optional. Filtern Sie die Liste der Konsumentengruppen mithilfe von Platzhalterzeichen (*) oder einem regulären Ausdruck mit Schrägstrichen (/) als Trennzeichen.
--json (optional)
Ausgabe im JSON-Format. Es werden maximal 1000 Gruppen zurückgegeben.

ibmcloud es group-delete

Konsumentengruppe löschen.

ibmcloud es group-delete [--group] GROUP_ID [--force]

Voraussetzungen: Keine

Befehlsoptionen:

--group wert, -g wert
Konsumentengruppen-ID
--force, -f (optional)
Löschen der Gruppe ohne Bestätigung.

ibmcloud es mirroring-topic-selection

Liste der Topicauswahl zum Spiegeln.

ibmcloud es mirroring-topic-selection [--json]

Voraussetzungen: Die Spiegelung ist in der Instanz Event Streams aktiviert. Event Streams-Plug-in, das für die Verbindung zum Spiegelungszielcluster über ibmcloud es init konfiguriert ist.

Befehlsoptionen:

--json (optional)
Ausgabe im JSON-Format.

ibmcloud es mirroring-topic-selection-set

Ersetzt die Topicauswahl für die Spiegelung.

ibmcloud es mirroring-topic-selection-set (--select pattern1,pattern2 | --none) [--force]

Voraussetzungen: Die Spiegelung ist in der Instanz Event Streams aktiviert. Event Streams-Plug-in, das für die Verbindung zum Spiegelungszielcluster über ibmcloud es init konfiguriert ist.

Befehlsoptionen:

--select wert
Auswahl der zu spiegelnden Themen als durch Kommas getrennte Muster für reguläre Ausdrücke. Verwenden Sie '.*', um alle Topics zu spiegeln.
--none
Löscht die zurzeit ausgewählten Topics (Spiegelung von Topics wird inaktiviert).
--force
Optional. Ersetzt die Topicauswahl für die Spiegelung ohne Bestätigungsaufforderung.

ibmcloud es mirroring-active-topics

Topics abrufen, die aktiv gespiegelt werden.

ibmcloud es mirroring-active-topics [--json]

Voraussetzungen: Die Spiegelung ist in der Instanz Event Streams aktiviert. Event Streams-Plug-in, das für die Verbindung zum Spiegelungszielcluster über ibmcloud es init konfiguriert ist.

Befehlsoptionen:

--json (optional)
Ausgabe im JSON-Format.

Hilfe zu ibmcloud es

Hilfe für einen Befehl anzeigen oder alle Befehle auflisten.

ibmcloud es help [COMMAND]

Voraussetzungen: Keine

Befehlsoptionen:

command (optional)
Hilfe zu einem Befehl anzeigen.

ibmcloud es schema-import

Importieren einer Gruppe von Schemas aus einer ZIP-Datei in die Registry

ibmcloud es schema-import [--file] ZIP_FILE_PATH

Voraussetzungen: Diese Operation ist nur für Enterprise-Instanzen zulässig, da nur der Enterprise-Plan eine Schemaregistry für die Verwendung und Verwaltung von Schemas enthält.

Befehlsoptionen:

--file Wert, -f Wert
Pfad der ZIP-Datei.

ibmcloud es Schemata

Schemas in der Registry auflisten.

ibmcloud es schemas [--json]

Voraussetzungen: Diese Operation ist nur für Enterprise-Instanzen zulässig, da nur der Enterprise-Plan eine Schemaregistry für die Verwendung und Verwaltung von Schemas enthält.

Befehlsoptionen:

--json
Optional. Ausgabe im JSON-Format.

ibmcloud es schema-create

Erstellen Sie ein Schema.

ibmcloud es schema-create [--artifact-id SCHEMA_ID] --file PATH_TO_FILE [--json]

Voraussetzungen: Diese Operation ist nur für Enterprise-Instanzen zulässig, da nur der Enterprise-Plan eine Schemaregistry für die Verwendung und Verwaltung von Schemas enthält.

Befehlsoptionen:

--artifact-id Wert
Optional. ID des zu erstellenden Schema-Artefakts. Wenn keine Angaben gemacht werden, wird eine ID generiert.
--file wert
Pfad zu einer Datei, die die JSON-Definition des zu erstellenden Schemas enthält.
--json
Optional. Ausgabe im JSON-Format.

ibmcloud es schema

Informationen über ein Schema anzeigen.

ibmcloud es schema [--artifact-id] SCHEMA_ID [--json]

Voraussetzungen: Diese Operation ist nur für Enterprise-Instanzen zulässig, da nur der Enterprise-Plan eine Schemaregistry für die Verwendung und Verwaltung von Schemas enthält.

Befehlsoptionen:

--artifact-id Wert
ID des Schemas.
--json
Optional. Ausgabe im JSON-Format.

ibmcloud es schema-update

Ändern Sie den Status eines Schemas.

ibmcloud es schema-update [--artifact-id] SCHEMA_ID --set ENABLED|DISABLED

Voraussetzungen: Diese Operation ist nur für Enterprise-Instanzen zulässig, da nur der Enterprise-Plan eine Schemaregistry für die Verwendung und Verwaltung von Schemas enthält.

Befehlsoptionen:

--artifact-id Wert
ID des Schemas.
--set wert
Neuer Zustand des Schemas, muss 'ENABLED' oder 'DISABLED' sein.

ibmcloud es schema-löschen

Ein Schema löschen.

ibmcloud es schema-delete [--artifact-id] SCHEMA_ID [--force]

Voraussetzungen: Diese Operation ist nur für Enterprise-Instanzen zulässig, da nur der Enterprise-Plan eine Schemaregistry für die Verwendung und Verwaltung von Schemas enthält. Das Schema muss sich im Zustand DISABLED befinden.

Befehlsoptionen:

--artifact-id Wert
ID des Schemas.
--force
Optional. Löschen Sie das Schema ohne Bestätigung.

ibmcloud es schema-versionen

Versionen eines Schemas anzeigen.

ibmcloud es schema-versions [--artifact-id] SCHEMA_ID [--json]

Voraussetzungen: Diese Operation ist nur für Enterprise-Instanzen zulässig, da nur der Enterprise-Plan eine Schemaregistry für die Verwendung und Verwaltung von Schemas enthält.

Befehlsoptionen:

--artifact-id Wert
ID des Schemas.
--json
Optional. Ausgabe im JSON-Format.

ibmcloud es schema-version-erstellen

Erstellen Sie eine neue Version eines Schemas.

ibmcloud es schema-version-create [--artifact-id] SCHEMA_ID --file PATH_TO_FILE [--json]

Voraussetzungen: Diese Operation ist nur für Enterprise-Instanzen zulässig, da nur der Enterprise-Plan eine Schemaregistry für die Verwendung und Verwaltung von Schemas enthält.

Befehlsoptionen:

--artifact-id Wert
ID des Schema-Artefakts, für das die neue Version erstellt werden soll.
--file wert
Pfad zu einer Datei, die die JSON-Definition der zu erstellenden Schemaversion enthält.
--json
Optional. Ausgabe im JSON-Format.

ibmcloud es schema-version

Informationen über eine Schemaversion anzeigen.

ibmcloud es schema-version [--artifact-id SCHEMA_ID --version VERSION] [--global-id GLOBAL_ID] [--json]

Voraussetzungen: Diese Operation ist nur für Enterprise-Instanzen zulässig, da nur der Enterprise-Plan eine Schemaregistry für die Verwendung und Verwaltung von Schemas enthält. Verwenden Sie entweder die Flaggen --artifact-id und --version oder die Flagge --global-id.

Befehlsoptionen:

--artifact-id Wert
ID des Schema-Artefakts.
--version wert
Version, die angezeigt werden soll.
--global-id Wert
Globale ID der anzuzeigenden Schemaversion.
--json
Optional. Ausgabe im JSON-Format.

ibmcloud es schema-version-update

Ändern Sie den Status einer Schemaversion.

ibmcloud es schema-version-update [--artifact-id] SCHEMA_ID --version VERSION --set ENABLED|DISABLED

Voraussetzungen: Diese Operation ist nur für Enterprise-Instanzen zulässig, da nur der Enterprise-Plan eine Schemaregistry für die Verwendung und Verwaltung von Schemas enthält.

Befehlsoptionen:

--artifact-id Wert
ID des Schema-Artefakts.
--version wert
Zu aktualisierende Version.
--set wert
Neuer Status der Schemaversion, muss entweder 'ENABLED' oder 'DISABLED' sein.
--json
Optional. Ausgabe im JSON-Format.

ibmcloud es schema-version-löschen

Eine Version eines Schemas löschen.

ibmcloud es schema-version-delete [--artifact-id] SCHEMA_ID --version VERSION [--force]

Voraussetzungen: Diese Operation ist nur für Enterprise-Instanzen zulässig, da nur der Enterprise-Plan eine Schemaregistry für die Verwendung und Verwaltung von Schemas enthält. Die Schemaversion muss sich im Zustand DISABLED befinden.

Befehlsoptionen:

--artifact-id Wert
ID des Schema-Artefakts.
--version wert
Zu löschende Version.
--force
Optional. Löschen Sie die Schemaversion ohne Bestätigung.

ibmcloud es schema-kompatibilität-regel-erstellen

Schemakompatibilitätsregel erstellen.

ibmcloud es schema-compatibility-rule-create [--artifact-id] SCHEMA_ID --set RULE

Voraussetzungen: Diese Operation ist nur für Enterprise-Instanzen zulässig, da nur der Enterprise-Plan eine Schemaregistry für die Verwendung und Verwaltung von Schemas enthält.

Befehlsoptionen:

--artifact-id Wert
ID des Schemas.
--set wert
Der Wert der Kompatibilitätsregel. Zulässige Werte sind "NONE", "FULL", "FULL_TRANSITIVE", "FORWARD", "FORWARD_TRANSITIVE", "BACKWARD" und "BACKWARD_TRANSITIVE".

ibmcloud es schema-kompatibilität-regel

Schema oder globale Kompatibilitätsregel anzeigen.

ibmcloud es es schema-compatibility-rule [ [--artifact-id] SCHEMA_ID | --global ]  [--json]

Voraussetzungen: Diese Operation ist nur für Enterprise-Instanzen zulässig, da nur der Enterprise-Plan eine Schemaregistry für die Verwendung und Verwaltung von Schemas enthält. Verwenden Sie entweder das --artifact-id oder das --global Flag.

Befehlsoptionen:

--artifact-id Wert
Optional. ID des Schemas.
--global
Optional. Anzeige der globalen Kompatibilitätsregel.
--json
Optional. Ausgabe im JSON-Format.

ibmcloud es schema-kompatibilität-regel-aktualisierung

Schema oder globale Kompatibilitätsregel ändern.

ibmcloud es schema-compatibility-rule-update [ [--artifact-id] SCHEMA_ID | --global ] --set RULE

Voraussetzungen: Diese Operation ist nur für Enterprise-Instanzen zulässig, da nur der Enterprise-Plan eine Schemaregistry für die Verwendung und Verwaltung von Schemas enthält. Verwenden Sie entweder das --artifact-id oder das --global Flag.

Befehlsoptionen:

--artifact-id Wert
Optional. ID des Schemas.
--global
Optional. Ändern Sie die globale Kompatibilitätsregel.
--set wert
Der Wert der Kompatibilitätsregel. Zulässige Werte sind "NONE", "FULL", "FULL_TRANSITIVE", "FORWARD", "FORWARD_TRANSITIVE", "BACKWARD" und "BACKWARD_TRANSITIVE".

ibmcloud es schema-kompatibilität-regel-löschen

Schemakompatibilitätsregel löschen.

ibmcloud es schema-compatibility-rule-delete [--artifact-id] SCHEMA_ID [--force]

Voraussetzungen: Diese Operation ist nur für Enterprise-Instanzen zulässig, da nur der Enterprise-Plan eine Schemaregistry für die Verwendung und Verwaltung von Schemas enthält.

Befehlsoptionen:

--artifact-id Wert
ID des Schemas.
--force
Optional. Löschen Sie die Kompatibilitätsregel ohne Bestätigung.