Référence de l'interface de ligne de commande Event Streams

Pour plus d'informations sur l'installation de l'interface de ligne de commande pour Event Streams, voirInitiation à l'interface de ligne de commande Event Streams.

Journal des modifications

Changelog pour le plug-in CLI Event Streams CLI plug-in
Version Date de publication Modifications
v1.0 12 mai 2019
  • Edition initiale de l'interface de ligne de commande Event Streams.
v1.0.1 27 mai 2019 -Message d'erreur amélioré lorsque vous exécutez la commande sans init.
-Liste des instances triées lors de l'initialisation.
-Mise à jour de la traduction.
v2.0 21 août 2019

-initialisation : suppression de la clé de service requise.

  • Ajout de la commande de suppression de groupe. Mise à jour de la traduction du texte d'aide.
v2.1 24 juin 2020
  • initialisation : affichage des paramètres de disposition pour l'instance d'entreprise.
  • Mise à jour de la traduction.
v2.1.1 10 juillet 2020
  • Remplacement de whitelist par 'allowlist`.
  • Correction de la configuration des couleurs.
  • Mise à jour de la traduction.
v2.2.0 3 août 2020
  • Ajout de la prise en charge de la fonction de mise en miroir.
v2.2.1 7 août 2020
  • init : Amélioration de l'affichage de la liste des adresses IP autorisées.
v2.3 9 novembre 2020
  • Ajout de la prise en charge de la configuration de l'audit des messages sur la rubrique
    -init : affichage de la clé de chiffrement si le paramètre kms_key_crn est spécifié durant la mise à disposition.
v2.3.2 5 mai 2022
  • Ajout de la prise en charge de Mac OS X M1/ARM.
  • init : Affichage du seau Object Storage si le paramètre cos_bucket_crn est spécifié dans le provisionnement.
v2.4.0 28 février 2023 -Ajout de la version Kafka à ibmcloud es cluster.
-Mise à jour vers 1.9.6.
v2.4.1 05 déc 2023 -Ajout de commandes mirroring-active-topics et help.
v2.5.0 15 décembre 2023 -Ajout de commandes schema-import.
v2.6.0 29 août 2024
  • Ajouté schemas, schema-create, schema, schema-update, schema-delete, schema-versions, schema-version-create, schema-version, schema-version-update, schema-version-delete, schema-compatibility-rule-create, schema-compatibility-rule, schema-compatibility-rule-update et schema-compatibility-rule-delete.
v2.6.1 01 Nov 2024
  • Correction des vulnérabilités.
v2.6.2 01 février 2025
  • Correction des vulnérabilités.
v2.7.0 25 févr. 2025
  • Les messages d'erreur renvoyés par le serveur kafka sont traduits.
  • Correction des paramètres d'impression de broker-config deux fois.
v2.7.1 01 mai 2025
  • Correction des vulnérabilités.
v2.7.3 29 avril 2026
  • Correction des vulnérabilités.
  • Modification mineure de la gestion des paramètres invalides. Si le paramètre facultatif n'est pas spécifié, les paramètres non valides peuvent être ignorés au lieu de renvoyer une erreur.

ibmcloud es init

Initialisez le plug-in Event Streams.

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

Prérequis : Aucun

Options de commande :

valeur --instance-name, valeur -i (facultatif)
Nom de l'instance Event Streams.
valeur --api-url, valeur -a (facultatif)
URL admin Kafka de l'instance Event Streams.

ibmcloud es broker

Affiche les détails d'un courtier spécifique.

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

Prérequis : Aucun

Options de commande :

valeur --broker, valeur -b
ID de courtier, vous pouvez spécifier avec ou sans l'indicateur --broker précédent.
--json (facultatif)
Format de sortie en JSON.

ibmcloud es broker-config

Affiche la configuration d'un courtier.

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

Prérequis : Aucun

Options de commande :

valeur --broker, valeur -b
ID de courtier, vous pouvez spécifier avec ou sans l'indicateur --broker précédent.
valeur --filter, valeur -f (facultatif)
Filtrez la liste de configuration en utilisant des caractères génériques (*) ou une expression régulière avec des barres obliques (/) en délimiteurs.
--verbose, -v (facultatif)
Afficher des informations de configuration prolixes.
--json (facultatif)
Format de sortie en JSON.

ibmcloud es cluster

Affiche les détails du cluster, y compris les détails de tous les courtiers et la version de Kafka.

ibmcloud es cluster [--json]

Prérequis : Aucun

Options de commande :

--json (facultatif)
Format de sortie en JSON.

ibmcloud es topic

Affiche les détails d'une rubrique.

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

Prérequis : Aucun

Options de commande :

valeur --name, valeur -n
Nom de la rubrique.
--json (facultatif)
Format de sortie de JSON.

ibmcloud es topic-create

Créer une nouvelle rubrique.

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

Prérequis : Aucun

Options de commande :

valeur --name, valeur -n

Nom de la rubrique.

valeur --partitions, valeur -p

Définit le nombre de partitions pour la rubrique.

--config KEY=VALUE, -c KEY=VALUE (facultatif)

Définit une option de configuration pour la rubrique en tant que paire KEY=VALUE.

Vous pouvez spécifier plusieurs options --config. Chaque option --config peut spécifier une liste d'affectations délimitées par des points-virgules. La liste suivante affiche les clés de configuration valides :

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

ibmcloud es topic-delete

Supprimer une rubrique.

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

Prérequis : Aucun

Options de commande :

valeur --name, valeur -n
Nom de la rubrique.
--force, -f (facultatif)
Supprimer sans confirmation.

ibmcloud es topic-delete-records

Supprime des enregistrements d'une rubrique pour une position donnée.

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

Prérequis : Aucun

Options de commande :

valeur --name, valeur -n
Nom de la rubrique.
--partition-offset PARTITION:OFFSET, -p PARTITION:OFFSET
Partition et position pour supprimer des enregistrements à partir d'un format PARTITION:OFFSET.
Vous pouvez spécifier plusieurs options --partition-offset ou spécifier plusieurs paires PARTITION:OFFSET, séparées par des délimiteurs points-virgules et entourées de guillemets simples, 'PARTITION1:OFFSET1;PARTITION2:OFFSET2;PARTITION3:OFFSET3', par exemple.
--force, -f (facultatif)
Supprimer les enregistrements sans confirmation.

ibmcloud es topic-partitions-set

Définit les partitions pour une rubrique.

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

Prérequis : Aucun

Options de commande :

valeur --name, valeur -n
Nom de la rubrique.
valeur --partitions, valeur -p
Définit le nombre de partitions pour la rubrique.

ibmcloud es topic-update

Met à jour la configuration d'une rubrique.

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

Prérequis : Aucun

Options de commande :

valeur --name, valeur -n

Nom de la rubrique.

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

Définit une option de configuration pour la rubrique en tant que paire KEY[= VALUE].

Si VALUE n'est pas indiqué, l'indicateur '--default' doit être spécifié pour indiquer la réinitialisation de la valeur de configuration à la valeur par défaut. Plusieurs options '--config' peuvent être spécifiées. Chaque option --config peut spécifier une liste d'affectations délimitées par des points-virgules. La liste suivante affiche les clés de configuration valides :

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

Rétablir la valeur par défaut de chaque paramètre de configuration spécifié à l'aide de '--config'.

ibmcloud es topics

Répertorie les rubriques.

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

Prérequis : Aucun

Options de commande :

valeur --filter, valeur -f (facultatif)
Nom de la rubrique.
--json (facultatif)
Formater la sortie en JSON Un maximum de 1000 rubriques est renvoyé.

ibmcloud es group

Affiche les détails d'un groupe de consommateurs.

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

>Prérequis : Aucun

Options de commande :

valeur --group, valeur -g
ID du groupe de consommateurs.
--json (facultatif)
Formater la sortie en JSON

ibmcloud es group-reset

Réinitialise les positions pour un groupe de consommateurs.

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

Prérequis : Aucun

Options de commande :

valeur --group, valeur -g
ID du groupe de consommateurs
valeur --topic, valeur -t
Nom de la rubrique. Ne s'applique qu'à cette rubrique. Omettre si l'indicateur '--all-topics' a été indiqué.
--all-topics, -a
S'applique à toutes les rubriques affectées au groupe. Omettre si l'indicateur '--topic' a été indiqué.
valeur --mode, valeur -m
L'une des valeurs suivantes : 'earliest', 'latest' ou 'datetime'.
valeur --value, valeur -v
Valeur pour réinitialisation des positions, basée sur --mode. A omettre pour earliest et latest. 'datetime': use 'YYYY-MM-DDTHH:mm:SS.sss[±hh:mm|Z]'.
--dry-run (facultatif)
Affiche les résultats et n'implémente pas les changements.
--execute (facultatif)
Exécute les changements dans les positions.
--json (facultatif)
Formater la sortie en JSON

ibmcloud es groups

Répertorie les groupes de consommateurs.

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

Prérequis : Aucun

Options de commande :

valeur --filter, valeur -f (facultatif)
Optionnel. Filtrez la liste des groupes de consommateurs à l'aide de caractères génériques (*) ou d'une expression régulière avec des barre oblique (/) en délimiteurs.
--json (facultatif)
Formater la sortie en JSON Un maximum de 1000 groupes est renvoyé.

ibmcloud es group-delete

Supprimer un groupe de consommateurs.

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

Prérequis : Aucun

Options de commande :

valeur --group, valeur -g
ID du groupe de consommateurs
--force, -f (facultatif)
Supprime un groupe sans confirmation.

ibmcloud es mirroring-topic-selection

Afficher la sélection des rubriques de mise en miroir.

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

Prérequis: la mise en miroir est activée sur l'instance Event Streams. Plug-in Event Streams configuré pour se connecter au cluster cible de la mise en miroir via ibmcloud es init.

Options de commande :

--json (facultatif)
Formater la sortie en JSON

ibmcloud es mirroring-topic-selection-set

Remplacer la sélection des rubriques de mise en miroir.

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

Prérequis: la mise en miroir est activée sur l'instance Event Streams. Plug-in Event Streams configuré pour se connecter au cluster cible de la mise en miroir via ibmcloud es init.

Options de commande :

--select value
Sélection de rubriques à mettre en miroir sous forme de modèles regex séparés par des virgules. Utilisez '.*' pour mettre en miroir toutes les rubriques.
--none
Supprimer les rubriques actuellement sélectionnées (désactiver la mise en miroir des rubriques).
--force
Optionnel. Remplacer la sélection des rubriques de mise en miroir sans confirmation.

ibmcloud es mirroring-active-topics

Obtenez les rubriques pour lesquelles la mise en miroir est activée.

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

Prérequis: la mise en miroir est activée sur l'instance Event Streams. Plug-in Event Streams configuré pour se connecter au cluster cible de la mise en miroir via ibmcloud es init.

Options de commande :

--json (facultatif)
Formater la sortie en JSON

aide ibmcloud es

Afficher l'aide d'une commande ou répertorier toutes les commandes.

ibmcloud es help [COMMAND]

Prérequis : Aucun

Options de commande :

Elément command (facultatif)
Afficher l'aide d'une commande.

ibmcloud es schema-import

Importez un ensemble de schémas dans le registre à partir d'un fichier zip.

ibmcloud es schema-import [--file] ZIP_FILE_PATH

Prérequis: cette opération est autorisée uniquement sur les instances Enterprise car seul le plan Enterprise inclut un registre de schéma pour l'utilisation et la gestion des schémas.

Options de commande :

--file valeur, -f valeur
Chemin d'accès au fichier zip.

ibmcloud es schemas

Répertorier les schémas dans le registre.

ibmcloud es schemas [--json]

Prérequis: cette opération est autorisée uniquement sur les instances Enterprise car seul le plan Enterprise inclut un registre de schéma pour l'utilisation et la gestion des schémas.

Options de commande :

--json
Optionnel. Formater la sortie en JSON

ibmcloud es schema-create

Créer un schéma.

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

Prérequis: cette opération est autorisée uniquement sur les instances Enterprise car seul le plan Enterprise inclut un registre de schéma pour l'utilisation et la gestion des schémas.

Options de commande :

--artifact-id valeur
Optionnel. ID de l'artefact de schéma à créer. S'il n'est pas fourni, un identifiant est généré.
--file valeur
Chemin d'accès à un fichier contenant la définition JSON du schéma à créer.
--json
Optionnel. Formater la sortie en JSON

ibmcloud es schema

Afficher des informations sur un schéma.

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

Prérequis: cette opération est autorisée uniquement sur les instances Enterprise car seul le plan Enterprise inclut un registre de schéma pour l'utilisation et la gestion des schémas.

Options de commande :

--artifact-id valeur
ID du schéma.
--json
Optionnel. Formater la sortie en JSON

ibmcloud es schema-update

Modifier l'état d'un schéma.

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

Prérequis: cette opération est autorisée uniquement sur les instances Enterprise car seul le plan Enterprise inclut un registre de schéma pour l'utilisation et la gestion des schémas.

Options de commande :

--artifact-id valeur
ID du schéma.
--set valeur
Nouvel état du schéma, doit être "ENABLED" ou "DISABLED".

ibmcloud es schema-delete

Supprimer un schéma.

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

Prérequis: cette opération est autorisée uniquement sur les instances Enterprise car seul le plan Enterprise inclut un registre de schéma pour l'utilisation et la gestion des schémas. Le schéma doit être dans l'état DISABLED.

Options de commande :

--artifact-id valeur
ID du schéma.
--force
Optionnel. Supprimer le schéma sans confirmation.

ibmcloud es schema-versions

Afficher les versions d'un schéma.

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

Prérequis: cette opération est autorisée uniquement sur les instances Enterprise car seul le plan Enterprise inclut un registre de schéma pour l'utilisation et la gestion des schémas.

Options de commande :

--artifact-id valeur
ID du schéma.
--json
Optionnel. Formater la sortie en JSON

ibmcloud es schema-version-create

Créer une nouvelle version d'un schéma.

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

Prérequis: cette opération est autorisée uniquement sur les instances Enterprise car seul le plan Enterprise inclut un registre de schéma pour l'utilisation et la gestion des schémas.

Options de commande :

--artifact-id valeur
ID de l'artefact de schéma pour lequel la nouvelle version doit être créée.
--file valeur
Chemin d'accès à un fichier contenant la définition JSON de la version du schéma à créer.
--json
Optionnel. Formater la sortie en JSON

ibmcloud es schema-version

Afficher des informations sur la version d'un schéma.

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

Prérequis: cette opération est autorisée uniquement sur les instances Enterprise car seul le plan Enterprise inclut un registre de schéma pour l'utilisation et la gestion des schémas. Utilisez les drapeaux --artifact-id et --version, ou le drapeau --global-id.

Options de commande :

--artifact-id valeur
ID de l'artefact de schéma.
--version valeur
Version à afficher.
--global-id valeur
ID global de la version du schéma à afficher.
--json
Optionnel. Formater la sortie en JSON

ibmcloud es schema-version-update

Modifier l'état d'une version de schéma.

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

Prérequis: cette opération est autorisée uniquement sur les instances Enterprise car seul le plan Enterprise inclut un registre de schéma pour l'utilisation et la gestion des schémas.

Options de commande :

--artifact-id valeur
ID de l'artefact de schéma.
--version valeur
Version à mettre à jour.
--set valeur
Nouvel état de la version du schéma, qui doit être soit "ENABLED", soit "DISABLED".
--json
Optionnel. Formater la sortie en JSON

ibmcloud es schema-version-delete

Supprimer une version d'un schéma.

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

Prérequis: cette opération est autorisée uniquement sur les instances Enterprise car seul le plan Enterprise inclut un registre de schéma pour l'utilisation et la gestion des schémas. La version du schéma doit être dans l'état DISABLED.

Options de commande :

--artifact-id valeur
ID de l'artefact de schéma.
--version valeur
Version à supprimer.
--force
Optionnel. Supprimer la version du schéma sans confirmation.

ibmcloud es schema-compatibility-rule-create

Créer une règle de compatibilité des schémas.

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

Prérequis: cette opération est autorisée uniquement sur les instances Enterprise car seul le plan Enterprise inclut un registre de schéma pour l'utilisation et la gestion des schémas.

Options de commande :

--artifact-id valeur
ID du schéma.
--set valeur
Valeur de la règle de compatibilité. Les valeurs autorisées sont "NONE", "FULL", "FULL_TRANSITIVE", "FORWARD", "FORWARD_TRANSITIVE", "BACKWARD" et "BACKWARD_TRANSITIVE".

ibmcloud es schema-compatibility-rule

Afficher le schéma ou la règle de compatibilité globale.

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

Prérequis: cette opération est autorisée uniquement sur les instances Enterprise car seul le plan Enterprise inclut un registre de schéma pour l'utilisation et la gestion des schémas. Utilisez soit le drapeau --artifact-id, soit le drapeau --global.

Options de commande :

--artifact-id valeur
Optionnel. ID du schéma.
--global
Optionnel. Afficher la règle de compatibilité globale.
--json
Optionnel. Formater la sortie en JSON

ibmcloud es schema-compatibility-rule-update

Modifier le schéma ou la règle de compatibilité globale.

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

Prérequis: cette opération est autorisée uniquement sur les instances Enterprise car seul le plan Enterprise inclut un registre de schéma pour l'utilisation et la gestion des schémas. Utilisez soit le drapeau --artifact-id, soit le drapeau --global.

Options de commande :

--artifact-id valeur
Optionnel. ID du schéma.
--global
Optionnel. Modifier la règle de compatibilité globale.
--set valeur
Valeur de la règle de compatibilité. Les valeurs autorisées sont "NONE", "FULL", "FULL_TRANSITIVE", "FORWARD", "FORWARD_TRANSITIVE", "BACKWARD" et "BACKWARD_TRANSITIVE".

ibmcloud es schema-compatibility-rule-delete

Supprimer la règle de compatibilité des schémas.

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

Prérequis: cette opération est autorisée uniquement sur les instances Enterprise car seul le plan Enterprise inclut un registre de schéma pour l'utilisation et la gestion des schémas.

Options de commande :

--artifact-id valeur
ID du schéma.
--force
Optionnel. Supprimer la règle de compatibilité sans confirmation.