Guida di riferimento alla CLI Event Streams
Per informazioni su come installare la CLI per Event Streams, vedere Operazioni preliminari con la CLI di Event Streams.
Changelog
| Versione | Data di rilascio | Modifiche |
|---|---|---|
| v1.0 | 12 maggio 2019 |
|
| v1.0.1 | 27 maggio 2019 |
|
| v2.0 | 21 agosto 2019 |
|
| v2.1 | 24 giugno 2020 |
|
| v2.1.1 | 10 luglio 2020 |
|
| v2.2.0 | 3 agosto 2020 |
|
| v2.2.1 | 7 agosto 2020 |
|
| v2.3 | 9 novembre 2020 |
|
| v2.3.2 | 5 maggio 2022 |
|
| v2.4.0 | 28 febbraio 2023 |
|
| v2.4.1 | 05 dicembre 2023 |
|
| v2.5.0 | 15 dicembre 2023 |
|
| v2.6.0 | 29 agosto 2024 |
|
| v2.6.1 | 01 nov 2024 |
|
| v2.6.2 | 01 feb 2025 |
|
| v2.7.0 | 25 febbraio 2025 |
|
| v2.7.1 | 01 maggio 2025 |
|
| v2.7.3 | 29 aprile 2026 |
|
ibmcloud es init
Inizializzare il plug-in Event Streams.
ibmcloud es init [-i|--instance-name INSTANCE_NAME] [-a|--api-url API_ENDPOINT_URL]
Prerequisiti: Nessuno
Opzioni comando:
- --instance-name value, -i value (facoltativo)
- Il nome dell'istanza Event Streams.
- --api-url value, -a value (facoltativo)
- URL dell'amministratore Kafka dell'istanza Event Streams.
ibmcloud es broker
Visualizza i dettagli di un broker specifico.
ibmcloud es broker [--broker] ID [--json]
Prerequisiti: Nessuno
Opzioni comando:
- --broker value, -b value
- ID del broker, lo puoi specificare con o senza un indicatore '--broker' che lo precede.
- --json (facoltativo)
- Formato di output in JSON.
ibmcloud es broker-config
Visualizza la configurazione di un broker.
ibmcloud es broker-config [--broker] ID [--filter FILTER] [--verbose] [--json]
Prerequisiti: Nessuno
Opzioni comando:
- --broker value, -b value
- ID del broker, lo puoi specificare con o senza un indicatore '--broker' che lo precede.
- --filter value, -f value (facoltativo)
- Filtrare l'elenco delle configurazioni usando i caratteri jolly (*) o un'espressione regolare con i delimitatori forward slash (/).
- --verbose, -v (facoltativo)
- Visualizza le informazioni sulla configurazione dettagliate.
- --json (facoltativo)
- Formato di output in JSON.
ibmcloud es cluster
Visualizza i dettagli del cluster, compresi i dettagli di tutti i broker e la versione di Kafka.
ibmcloud es cluster [--json]
Prerequisiti: Nessuno
Opzioni comando:
- --json (facoltativo)
- Formato di output in JSON.
ibmcloud es topic
Visualizza i dettagli di un argomento.
ibmcloud es topic [--name] TOPIC_NAME [--json]
Prerequisiti: Nessuno
Opzioni comando:
- --name value, -n value
- Nome argomento.
- --json (facoltativo)
- Formato di output in JSON.
ibmcloud es topic-create
Crea un nuovo argomento.
ibmcloud es topic-create [--name] TOPIC_NAME [--partitions PARTITIONS] [--config KEY=VALUE[;KEY=VALUE]* ]*
Prerequisiti: Nessuno
Opzioni comando:
- --name value, -n value
-
Nome argomento.
- --partitions value, -p value
-
Imposta il numero di partizioni per l'argomento.
- --config KEY=VALUE, -c KEY=VALUE (facoltativo)
-
Imposta un'opzione di configurazione per l'argomento come una coppia KEY=VALUE.
-
Puoi specificare più opzioni --config. Ogni opzione '--config' può specificare un elenco delimitato da punti e virgola di assegnazioni. Il seguente elenco mostra le chiavi di configurazione valide:
- cleanup.policy
- retention.ms
- retention.bytes
- segment.bytes
- segment.ms
- segment.index.bytes
ibmcloud es topic-delete
Elimina un argomento.
ibmcloud es topic-delete [--name] TOPIC_NAME [--force]
Prerequisiti: Nessuno
Opzioni comando:
- --name value, -n value
- Nome argomento.
- --force, -f (facoltativo)
- Elimina senza conferma.
ibmcloud es topic-delete-records
Elimina i record da un argomento per un offset fornito.
ibmcloud es topic-delete-records [--name] TOPIC_NAME [--partition-offset PARTITION:OFFSET[;PARTITION:OFFSET]* ]* [--force]
Prerequisiti: Nessuno
Opzioni comando:
- --name value, -n value
- Nome argomento.
- --partition-offset PARTITION:OFFSET, -p PARTITION:OFFSET
- La partizione e l'offset da cui eliminare i record in formato PARTITION:OFFSET.
- Puoi specificare più opzioni --partition-offset oppure più coppie PARTITION:OFFSET con delimitatori punto e virgola racchiuse tra virgolette: 'PARTITION1:OFFSET1;PARTITION2:OFFSET2;PARTITION3:OFFSET3'.
- --force, -f (facoltativo)
- Elimina i record senza conferma.
ibmcloud es topic-partitions-set
Imposta le partizioni per un argomento.
ibmcloud es topic-partitions-set [--name] TOPIC_NAME --partitions PARTITIONS
Prerequisiti: Nessuno
Opzioni comando:
- --name value, -n value
- Nome argomento.
- --partitions value, -p value
- Imposta il numero di partizioni per l'argomento.
ibmcloud es topic-update
Aggiorna la configurazione per un argomento.
ibmcloud es topic-update [--name] TOPIC_NAME --config KEY[=VALUE][;KEY[=VALUE]]* [--default]
Prerequisiti: Nessuno
Opzioni comando:
- --name value, -n value
-
Nome argomento.
- --config [CHIAVE=VALORE], -c [CHIAVE=VALORE]
-
Imposta un'opzione di configurazione per l'argomento come coppia [KEY=VALUE].
-
Se VALUE non viene fornito, occorre specificare il flag '--default' per indicare il ripristino del valore di configurazione predefinito. È possibile specificare più opzioni di '--config'. Ogni opzione '--config' può specificare un elenco delimitato da punti e virgola di assegnazioni. Il seguente elenco mostra le chiavi di configurazione valide:
- cleanup.policy
- retention.ms
- retention.bytes
- segment.bytes
- segment.ms
- segment.index.bytes
- --default, -d (facoltativo)
-
Ripristina il valore predefinito di ogni parametro di configurazione specificato da '--config'.
ibmcloud es topics
Elenca gli argomenti.
ibmcloud es topics [--filter FILTER] [--json]
Prerequisiti: Nessuno
Opzioni comando:
- --filter value, -f value (facoltativo)
- Nome argomento.
- --json (facoltativo)
- Formatta l'output in JSON. Vengono restituiti fino a 1000 argomenti.
ibmcloud es group
Visualizza i dettagli di un gruppo di consumatori.
ibmcloud es group [--group] GROUP_ID [--json]
>Prequisiti: Nessuno
Opzioni comando:
- --group value, -g value
- ID gruppo di consumatori.
- --json (facoltativo)
- Formatta l'output in JSON.
ibmcloud es group-reset
Reimposta gli offset per un gruppo di consumatori.
ibmcloud es group-reset [--group] GROUP_ID [--topic TOPIC_NAME] [--all-topics] --mode MODE --value VALUE [--dry-run] [--execute] [--json]
Prerequisiti: Nessuno
Opzioni comando:
- --group value, -g value
- ID gruppo di consumer
- --topic value, -t value
- Nome argomento. Viene applicato a soltanto questo argomento. Omettere se è stato fornito il flag '--all-topics'.
- --all-topics, -a
- Viene applicato a tutti gli argomenti assegnati al gruppo. Omettere se è stato fornito il flag '--topic'.
- --mode value, -m value
- Uno dei seguenti valori: 'earliest', 'latest' o 'datetime'.
- --value value, -v value
- Valore per reimpostare gli offset, basato su '--mode'. Ometti per 'earliest' e 'latest'. 'datetime': utilizzare ' YYYY-MM-DDTHH:mm:SS.sss[ ±hh:mm|Z] '.
- --dry-run (facoltativo)
- Mostra i risultati e non implementa le modifiche.
- --execute (facoltativo)
- Esegue le modifiche agli offset.
- --json (facoltativo)
- Formatta l'output in JSON.
ibmcloud es groups
Elenca i gruppi di consumatori.
ibmcloud es groups [--filter FILTER] [--json]
Prerequisiti: Nessuno
Opzioni comando:
- --filter value, -f value (facoltativo)
- Facoltativo. Filtrare l'elenco dei gruppi di consumatori utilizzando i caratteri jolly (*) o un'espressione regolare con delimitatori di barra in avanti (/).
- --json (facoltativo)
- Formatta l'output in JSON. Viene restituito un massimo di 1000 gruppi.
ibmcloud es group-delete
Elimina un gruppo di consumatori.
ibmcloud es group-delete [--group] GROUP_ID [--force]
Prerequisiti: Nessuno
Opzioni comando:
- --group value, -g value
- ID gruppo di consumer
- --force, -f (facoltativo)
- Elimina il gruppo senza conferma.
ibmcloud es mirroring - argomento - selezione
Elenca le selezioni dell'argomento di mirroring.
ibmcloud es mirroring-topic-selection [--json]
Prerequisiti: mirroring abilitato sull'istanza Event Streams. Plug-in Event Streams configurato per la connessione al cluster di destinazione di mirroring tramite ibmcloud es init.
Opzioni comando:
- --json (facoltativo)
- Formatta l'output in JSON.
ibmcloud es mirroring - topic - selection - set
Sostituire la selezione argomento di mirroring.
ibmcloud es mirroring-topic-selection-set (--select pattern1,pattern2 | --none) [--force]
Prerequisiti: mirroring abilitato sull'istanza Event Streams. Plug-in Event Streams configurato per la connessione al cluster di destinazione di mirroring tramite ibmcloud es init.
Opzioni comando:
- --select valore
- Selezione degli argomenti da rispecchiare come modelli regex separati da virgole. Utilizzare '.*' per eseguire il mirroring di tutti gli argomenti.
- --none
- Annullare gli argomenti attualmente selezionati (disabilitare il mirroring degli argomenti).
- --force
- Facoltativo. Sostituire la selezione dell'argomento di mirroring senza conferma.
ibmcloud es mirroring - active - topics
Acquisire gli argomenti che sono attivamente sottoposti a mirroring.
ibmcloud es mirroring-active-topics [--json]
Prerequisiti: mirroring abilitato sull'istanza Event Streams. Plug-in Event Streams configurato per la connessione al cluster di destinazione di mirroring tramite ibmcloud es init.
Opzioni comando:
- --json (facoltativo)
- Formatta l'output in JSON.
guida di ibmcloud es
Visualizzare la guida per un comando o elencare tutti i comandi.
ibmcloud es help [COMMAND]
Prerequisiti: Nessuno
Opzioni comando:
- command (facoltativo)
- Mostra la guida per un comando.
ibmcloud es schema - import
Importare una serie di schemi nel registro da un file zip.
ibmcloud es schema-import [--file] ZIP_FILE_PATH
Prerequisiti: questa operazione è consentita solo su istanze Enterprise poiché solo il piano Enterprise include un Registro schema per utilizzare e gestire gli schemi.
Opzioni comando:
- --file value, -f value
- Percorso file zip.
schemi ibmcloud es
Elenca gli schemi nel registro.
ibmcloud es schemas [--json]
Prerequisiti: questa operazione è consentita solo su istanze Enterprise poiché solo il piano Enterprise include un Registro schema per utilizzare e gestire gli schemi.
Opzioni comando:
- --json
- Facoltativo. Formatta l'output in JSON.
ibmcloud es schema-create
Creare uno schema.
ibmcloud es schema-create [--artifact-id SCHEMA_ID] --file PATH_TO_FILE [--json]
Prerequisiti: questa operazione è consentita solo su istanze Enterprise poiché solo il piano Enterprise include un Registro schema per utilizzare e gestire gli schemi.
Opzioni comando:
- --artifact-id valore
- Facoltativo. ID dell'artefatto schema da creare. Se non viene fornito, viene generato un ID.
- --file valore
- Percorso di un file contenente la definizione JSON dello schema da creare.
- --json
- Facoltativo. Formatta l'output in JSON.
schema ibmcloud es
Visualizza le informazioni su uno schema.
ibmcloud es schema [--artifact-id] SCHEMA_ID [--json]
Prerequisiti: questa operazione è consentita solo su istanze Enterprise poiché solo il piano Enterprise include un Registro schema per utilizzare e gestire gli schemi.
Opzioni comando:
- --artifact-id valore
- ID dello schema.
- --json
- Facoltativo. Formatta l'output in JSON.
ibmcloud es schema-update
Modificare lo stato di uno schema.
ibmcloud es schema-update [--artifact-id] SCHEMA_ID --set ENABLED|DISABLED
Prerequisiti: questa operazione è consentita solo su istanze Enterprise poiché solo il piano Enterprise include un Registro schema per utilizzare e gestire gli schemi.
Opzioni comando:
- --artifact-id valore
- ID dello schema.
- --set valore
- Nuovo stato dello schema, che deve essere "ABILITATO" o "DISABILITATO".
ibmcloud es schema-delete
Eliminare uno schema.
ibmcloud es schema-delete [--artifact-id] SCHEMA_ID [--force]
Prerequisiti: questa operazione è consentita solo su istanze Enterprise poiché solo il piano Enterprise include un Registro schema per utilizzare e gestire gli schemi. Lo schema deve essere in stato DISABLED.
Opzioni comando:
- --artifact-id valore
- ID dello schema.
- --force
- Facoltativo. Elimina lo schema senza conferma.
ibmcloud es schema-versioni
Visualizza le versioni di uno schema.
ibmcloud es schema-versions [--artifact-id] SCHEMA_ID [--json]
Prerequisiti: questa operazione è consentita solo su istanze Enterprise poiché solo il piano Enterprise include un Registro schema per utilizzare e gestire gli schemi.
Opzioni comando:
- --artifact-id valore
- ID dello schema.
- --json
- Facoltativo. Formatta l'output in JSON.
ibmcloud es schema-versione-creazione
Creare una nuova versione di uno schema.
ibmcloud es schema-version-create [--artifact-id] SCHEMA_ID --file PATH_TO_FILE [--json]
Prerequisiti: questa operazione è consentita solo su istanze Enterprise poiché solo il piano Enterprise include un Registro schema per utilizzare e gestire gli schemi.
Opzioni comando:
- --artifact-id valore
- ID dell'artefatto dello schema per il quale deve essere creata la nuova versione.
- --file valore
- Percorso di un file contenente la definizione JSON della versione dello schema da creare.
- --json
- Facoltativo. Formatta l'output in JSON.
ibmcloud es schema-versione
Visualizza informazioni sulla versione di uno schema.
ibmcloud es schema-version [--artifact-id SCHEMA_ID --version VERSION] [--global-id GLOBAL_ID] [--json]
Prerequisiti: questa operazione è consentita solo su istanze Enterprise poiché solo il piano Enterprise include un Registro schema per utilizzare e gestire gli schemi. Utilizzare i flag --artifact-id e --version,
oppure il flag --global-id.
Opzioni comando:
- --artifact-id valore
- ID dell'artefatto dello schema.
- --version valore
- Versione da visualizzare.
- --global-id valore
- ID globale della versione dello schema da visualizzare.
- --json
- Facoltativo. Formatta l'output in JSON.
ibmcloud es schema-versione-aggiornamento
Modifica lo stato di una versione dello schema.
ibmcloud es schema-version-update [--artifact-id] SCHEMA_ID --version VERSION --set ENABLED|DISABLED
Prerequisiti: questa operazione è consentita solo su istanze Enterprise poiché solo il piano Enterprise include un Registro schema per utilizzare e gestire gli schemi.
Opzioni comando:
- --artifact-id valore
- ID dell'artefatto dello schema.
- --version valore
- Versione da aggiornare.
- --set valore
- Nuovo stato della versione dello schema, che deve essere 'ENABLED' o 'DISABLED'.
- --json
- Facoltativo. Formatta l'output in JSON.
ibmcloud es schema-versione-cancellazione
Elimina una versione di uno schema.
ibmcloud es schema-version-delete [--artifact-id] SCHEMA_ID --version VERSION [--force]
Prerequisiti: questa operazione è consentita solo su istanze Enterprise poiché solo il piano Enterprise include un Registro schema per utilizzare e gestire gli schemi. La versione dello schema deve essere in stato DISABLED.
Opzioni comando:
- --artifact-id valore
- ID dell'artefatto dello schema.
- --version valore
- Versione da cancellare.
- --force
- Facoltativo. Cancellare la versione dello schema senza conferma.
ibmcloud es schema-compatibilità-regola-creazione
Creare una regola di compatibilità dello schema.
ibmcloud es schema-compatibility-rule-create [--artifact-id] SCHEMA_ID --set RULE
Prerequisiti: questa operazione è consentita solo su istanze Enterprise poiché solo il piano Enterprise include un Registro schema per utilizzare e gestire gli schemi.
Opzioni comando:
- --artifact-id valore
- ID dello schema.
- --set valore
- Il valore della regola di compatibilità. I valori ammessi sono "NONE", "FULL", "FULL_TRANSITIVE", "FORWARD", "FORWARD_TRANSITIVE", "BACKWARD" e "BACKWARD_TRANSITIVE".
ibmcloud es schema-compatibilità-regola
Visualizza lo schema o la regola di compatibilità globale.
ibmcloud es es schema-compatibility-rule [ [--artifact-id] SCHEMA_ID | --global ] [--json]
Prerequisiti: questa operazione è consentita solo su istanze Enterprise poiché solo il piano Enterprise include un Registro schema per utilizzare e gestire gli schemi. Utilizzare il flag --artifact-id o --global.
Opzioni comando:
- --artifact-id valore
- Facoltativo. ID dello schema.
- --global
- Facoltativo. Visualizza la regola di compatibilità globale.
- --json
- Facoltativo. Formatta l'output in JSON.
ibmcloud es schema-compatibilità-regola-update
Modifica dello schema o della regola di compatibilità globale.
ibmcloud es schema-compatibility-rule-update [ [--artifact-id] SCHEMA_ID | --global ] --set RULE
Prerequisiti: questa operazione è consentita solo su istanze Enterprise poiché solo il piano Enterprise include un Registro schema per utilizzare e gestire gli schemi. Utilizzare il flag --artifact-id o --global.
Opzioni comando:
- --artifact-id valore
- Facoltativo. ID dello schema.
- --global
- Facoltativo. Modificare la regola di compatibilità globale.
- --set valore
- Il valore della regola di compatibilità. I valori ammessi sono "NONE", "FULL", "FULL_TRANSITIVE", "FORWARD", "FORWARD_TRANSITIVE", "BACKWARD" e "BACKWARD_TRANSITIVE".
ibmcloud es schema-compatibilità-regola-eliminazione
Eliminare la regola di compatibilità dello schema.
ibmcloud es schema-compatibility-rule-delete [--artifact-id] SCHEMA_ID [--force]
Prerequisiti: questa operazione è consentita solo su istanze Enterprise poiché solo il piano Enterprise include un Registro schema per utilizzare e gestire gli schemi.
Opzioni comando:
- --artifact-id valore
- ID dello schema.
- --force
- Facoltativo. Elimina la regola di compatibilità senza conferma.