IBM Cloud Docs
Referência da CLI do Event Streams

Referência da CLI do Event Streams

Se você deseja informações sobre como instalar a CLI para Event Streams, consulte Introdução à CLI do Event Streams.

Log de mudanças

Registro de alterações para o Event Streams Plug-in da CLI
Versão Data de liberação Mudanças
v1.0 12 de maio de 2019
  • Liberação inicial da CLI do Event Streams.
v1.0.1 27 de maio de 2019 -Mensagem de erro melhorada quando você executa o comando sem init.
-Lista de instâncias sorteadas durante init.
-Atuação de tradução.
v2.0 21 de agosto de 2019
  • init: removido o requisito service-key.
  • Incluído o comando group-delete. Traduções atualizadas do texto de ajuda.
v2.1 24 de junho de 2020
  • init: parâmetros de provisão exibidos para a instância do Enterprise.
  • Atualização de tradução.
v2.1.1 10 de julho de 2020
  • Substituído whitelist por 'allowlist`.
  • Corrigida a configuração de cores.
  • Atualização da tradução.
v2.2.0 3 de agosto de 2020
  • Suporte incluído para o recurso de Espelhamento.
v2.2.1 7 de agosto de 2020
  • init: Aprimorou a exibição da lista de permissões de IP.
v2.3 9 de novembro de 2020
  • Suporte incluído para configurar a auditoria de mensagens no tópico.
  • init: exibir chave de criptografia se o parâmetro kms_key_crn for especificado no fornecimento.
v2.3.2 5 de maio de 2022
  • Adicionado suporte para Mac OS X M1/ARM.
  • init: Exibir o bucket Object Storage se o parâmetro cos_bucket_crn for especificado no provisionamento.
v2.4.0 28 de fevereiro de 2023 -Incluído a versão do Kafka para ibmcloud es cluster.
-Atualizado Acesse 1.9.6
v2.4.1 05 Dez 2023 -Comandos mirroring-active-topics e help incluídos.
v2.5.0 15 de dezembro de 2023. -Comandos do schema-import incluídos
v2.6.0 29 de agosto de 2024
  • Adicionados 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 e schema-compatibility-rule-delete.
v2.6.1 01 de novembro de 2024
  • Correções de vulnerabilidades.
v2.6.2 01 de fevereiro de 2025
  • Correções de vulnerabilidades.
v2.7.0 25 de fevereiro de 2025
  • As mensagens de erro retornadas do servidor kafka são translated.
  • Corrigir broker-config configurações de impressão duas vezes.
v2.7.1 01 de maio de 2025
  • Correções de vulnerabilidades.

ibmcloud es init

Inicialize o plug-in Event Streams.

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

Pré-requisitos: nenhum

Opções de comando:

--instance-name value, -i value (opcional)
Nome da instância do Event Streams.
--api-url value, -a value (opcional)
URL de administrador do Kafka da instância do Event Streams.

ibmcloud es broker

Exibir os detalhes de um corretor específico.

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

Pré-requisitos: nenhum

Opções de comando:

--broker value, -b value
ID do broker, é possível especificar com ou sem uma sinalização '--broker' anterior.
--json (opcional)
Formato de saída em JSON.

ibmcloud es broker-config

Exibir a configuração de um broker.

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

Pré-requisitos: nenhum

Opções de comando:

--broker value, -b value
ID do broker, é possível especificar com ou sem uma sinalização '--broker' anterior.
--filter value, -f value (opcional)
Filtre a lista de configuração usando curingas (*) ou uma expressão regular com delimitadores de barra (/).
--verbose, -v (opcional)
Exiba as informações de configuração detalhadas.
--json (opcional)
Formato de saída em JSON.

ibmcloud es cluster

Exibir os detalhes do cluster, incluindo detalhes de todos os brokers e a versão Kafka.

ibmcloud es cluster [--json]

Pré-requisitos: nenhum

Opções de comando:

--json (opcional)
Formato de saída em JSON.

ibmcloud es topic

Exibir os detalhes de um tópico.

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

Pré-requisitos: nenhum

Opções de comando:

--name value, -n value
Nome do tópico.
--json (opcional)
Formato de saída de JSON.

ibmcloud es topic-create

Criar um novo tópico.

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

Pré-requisitos: nenhum

Opções de comando:

--name value, -n value

Nome do tópico.

--partitions value, -p value

Configurar o número de partições para o tópico.

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

Configurar uma opção de configuração para o tópico como um par KEY=VALUE.

É possível especificar várias opções --config. Cada opção '--config' pode especificar uma lista de designações delimitadas por ponto e vírgula. A lista a seguir mostra chaves de configuração válidas:

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

ibmcloud es topic-delete

Excluir um tópico.

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

Pré-requisitos: nenhum

Opções de comando:

--name value, -n value
Nome do tópico.
--force, -f (opcional)
Exclui sem confirmação.

ibmcloud es topic-delete-records

Excluir registros de um tópico para uma determinada compensação.

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

Pré-requisitos: nenhum

Opções de comando:

--name value, -n value
Nome do tópico.
--partition-offset PARTITION:OFFSET, -p PARTITION:OFFSET
A partição e a compensação das quais excluir registros no formato PARTITION:OFFSET.
É possível especificar múltiplas opções --partition-offset ou é possível especificar múltiplos pares PARTITION:OFFSET com delimitadores de ponto e vírgula e cercados por aspas:'PARTITION1:OFFSET1;PARTITION2:OFFSET2;PARTITION3:OFFSET3'.
--force, -f (opcional)
Excluir registros sem confirmação.

ibmcloud es topic-partitions-set

Configurar as partições para um tópico.

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

Pré-requisitos: nenhum

Opções de comando:

--name value, -n value
Nome do tópico.
--partitions value, -p value
Configurar o número de partições para o tópico.

ibmcloud es topic-update

Atualizar a configuração para um tópico.

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

Pré-requisitos: nenhum

Opções de comando:

--name value, -n value

Nome do tópico.

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

Configure uma opção de configuração para o tópico como um par KEY[=VALUE].

Se VALUE não for fornecido, a sinalização '--default' deverá ser especificada para indicar a redefinição do valor de configuração de volta para o padrão. Várias opções do site '--config' podem ser especificadas. Cada opção '--config' pode especificar uma lista de designações delimitadas por ponto e vírgula. A lista a seguir mostra chaves de configuração válidas:

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

Redefina cada parâmetro de configuração especificado usando '--config' para seu valor padrão.

ibmcloud es topics

Listar tópicos.

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

Pré-requisitos: nenhum

Opções de comando:

--filter value, -f value (opcional)
Nome do tópico.
--json (opcional)
Saída no formato JSON. Até 1.000 tópicos são retornados.

ibmcloud es group

Exibir detalhes de um grupo de consumidores.

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

>Pré-requisitos: nenhum

Opções de comando:

--group value, -g value
ID do grupo de consumidores.
--json (opcional)
Saída no formato JSON.

ibmcloud es group-reset

Reconfigurar as compensações para um grupo de consumidores.

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

Pré-requisitos: nenhum

Opções de comando:

--group value, -g value
ID do grupo de consumidores
--topic value, -t value
Nome do tópico. Aplicar apenas a esse tópico. Omitir se a sinalização '--all-topics' foi fornecida.
--all-topics, -a
Aplicar a todos os tópicos designados ao grupo. Omitir se a sinalização '--topic' foi fornecida.
--mode value, -m value
Um dos valores a seguir: 'earliest', 'latest' ou 'datetime'.
--value value, -v value
Valor para reajustar compensações, com base em '--mode'. Omitir para 'mais cedo' e 'mais recente'. 'datetime': use 'YYYY-MM-DDTHH:mm:SS.sss[±hh:mm|Z]'.
--dry-run (opcional)
Mostrar resultados e não implementar as mudanças.
--execute (opcional)
Execute as mudanças para as compensações.
--json (opcional)
Saída no formato JSON.

ibmcloud es groups

Listar grupos de consumidores.

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

Pré-requisitos: nenhum

Opções de comando:

--filter value, -f value (opcional)
Opcional. Filtre a lista de grupos de consumidores usando curingas (*) ou uma expressão regular com delimitadores de barra (/).
--json (opcional)
Saída no formato JSON. Um máximo de 1.000 grupos é retornado.

ibmcloud es group-delete

Excluir um grupo de consumidores.

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

Pré-requisitos: nenhum

Opções de comando:

--group value, -g value
ID do grupo de consumidores
--force, -f (opcional)
Excluir grupo sem confirmação.

ibmcloud es mirroring-topic-selection

Listar seleção de tópico de espelhamento.

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

Pré-requisitos: espelhamento ativado na instância do Event Streams. Plug-in do Event Streams configurado para se conectar ao cluster de destino de espelhamento por meio do ibmcloud es init.

Opções de comando:

--json (opcional)
Saída no formato JSON.

ibmcloud es mirroring-topic-selection-set

Substituir a seleção de tópico de espelhamento.

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

Pré-requisitos: espelhamento ativado na instância do Event Streams. Plug-in do Event Streams configurado para se conectar ao cluster de destino de espelhamento por meio do ibmcloud es init.

Opções de comando:

--select value
Seleção de tópicos a serem espelhados como padrões de expressão regular separados por vírgula. Use '.*' para espelhar todos os tópicos.
--none
Limpar tópicos atualmente selecionados (desativar o espelhamento de tópicos).
--force
Opcional. Substituir a seleção de tópico de espelhamento sem confirmação.

ibmcloud es mirroring-active-topics

Obtenha tópicos que estão sendo espelhados ativamente.

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

Pré-requisitos: espelhamento ativado na instância do Event Streams. Plug-in do Event Streams configurado para se conectar ao cluster de destino de espelhamento por meio do ibmcloud es init.

Opções de comando:

--json (opcional)
Saída no formato JSON.

ibmcloud es ajuda

Mostra ajuda para um comando ou lista todos os comandos.

ibmcloud es help [COMMAND]

Pré-requisitos: nenhum

Opções de comando:

command (opcional)
Mostrar ajuda para um comando.

ibmcloud es schema-import

Importe um conjunto de esquemas no registro de um arquivo zip.

ibmcloud es schema-import [--file] ZIP_FILE_PATH

Pré-requisitos: Esta operação é permitida apenas em instâncias Enterprise, pois apenas o plano Enterprise inclui um Registro de Esquema para usar e gerenciar esquemas.

Opções de comando:

--file valor, -f valor
Caminho do arquivo Zip

ibmcloud es schemas

Liste os esquemas no registro.

ibmcloud es schemas [--json]

Pré-requisitos: Esta operação é permitida apenas em instâncias Enterprise, pois apenas o plano Enterprise inclui um Registro de Esquema para usar e gerenciar esquemas.

Opções de comando:

--json
Opcional. Saída no formato JSON.

ibmcloud es schema-create

Criar um esquema.

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

Pré-requisitos: Esta operação é permitida apenas em instâncias Enterprise, pois apenas o plano Enterprise inclui um Registro de Esquema para usar e gerenciar esquemas.

Opções de comando:

--artifact-id valor
Opcional. ID do artefato de esquema a ser criado. Se não for fornecido, será gerada uma ID.
--file valor
Caminho para um arquivo que contém a definição JSON do esquema a ser criado.
--json
Opcional. Saída no formato JSON.

ibmcloud es schema

Exibir informações sobre um esquema.

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

Pré-requisitos: Esta operação é permitida apenas em instâncias Enterprise, pois apenas o plano Enterprise inclui um Registro de Esquema para usar e gerenciar esquemas.

Opções de comando:

--artifact-id valor
ID do esquema.
--json
Opcional. Saída no formato JSON.

ibmcloud es schema-update

Alterar o estado de um esquema.

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

Pré-requisitos: Esta operação é permitida apenas em instâncias Enterprise, pois apenas o plano Enterprise inclui um Registro de Esquema para usar e gerenciar esquemas.

Opções de comando:

--artifact-id valor
ID do esquema.
--set valor
Novo estado do esquema, deve ser 'ENABLED' ou 'DISABLED'.

ibmcloud es schema-delete

Excluir um esquema.

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

Pré-requisitos: Esta operação é permitida apenas em instâncias Enterprise, pois apenas o plano Enterprise inclui um Registro de Esquema para usar e gerenciar esquemas. O esquema deve estar no estado DISABLED.

Opções de comando:

--artifact-id valor
ID do esquema.
--force
Opcional. Excluir o esquema sem confirmação.

ibmcloud es schema-versions

Exibir versões de um esquema.

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

Pré-requisitos: Esta operação é permitida apenas em instâncias Enterprise, pois apenas o plano Enterprise inclui um Registro de Esquema para usar e gerenciar esquemas.

Opções de comando:

--artifact-id valor
ID do esquema.
--json
Opcional. Saída no formato JSON.

ibmcloud es schema-version-create

Criar uma nova versão de um esquema.

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

Pré-requisitos: Esta operação é permitida apenas em instâncias Enterprise, pois apenas o plano Enterprise inclui um Registro de Esquema para usar e gerenciar esquemas.

Opções de comando:

--artifact-id valor
ID do artefato de esquema para o qual a nova versão deve ser criada.
--file valor
Caminho para um arquivo que contém a definição JSON da versão do esquema a ser criada.
--json
Opcional. Saída no formato JSON.

ibmcloud es schema-version

Exibir informações sobre uma versão de esquema.

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

Pré-requisitos: Esta operação é permitida apenas em instâncias Enterprise, pois apenas o plano Enterprise inclui um Registro de Esquema para usar e gerenciar esquemas. Use os sinalizadores --artifact-id e --version ou o sinalizador --global-id.

Opções de comando:

--artifact-id valor
ID do artefato de esquema.
--version valor
Versão a ser exibida.
--global-id valor
ID global da versão do esquema a ser exibida.
--json
Opcional. Saída no formato JSON.

ibmcloud es schema-version-update

Alterar o estado de uma versão de esquema.

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

Pré-requisitos: Esta operação é permitida apenas em instâncias Enterprise, pois apenas o plano Enterprise inclui um Registro de Esquema para usar e gerenciar esquemas.

Opções de comando:

--artifact-id valor
ID do artefato de esquema.
--version valor
Versão a ser atualizada.
--set valor
Novo estado da versão do esquema, que deve ser 'ENABLED' ou 'DISABLED'.
--json
Opcional. Saída no formato JSON.

ibmcloud es schema-version-delete

Excluir uma versão de um esquema.

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

Pré-requisitos: Esta operação é permitida apenas em instâncias Enterprise, pois apenas o plano Enterprise inclui um Registro de Esquema para usar e gerenciar esquemas. A versão do esquema deve estar no estado DISABLED.

Opções de comando:

--artifact-id valor
ID do artefato de esquema.
--version valor
Versão a ser excluída.
--force
Opcional. Excluir a versão do esquema sem confirmação.

ibmcloud es schema-compatibility-rule-create

Criar regra de compatibilidade de esquema.

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

Pré-requisitos: Esta operação é permitida apenas em instâncias Enterprise, pois apenas o plano Enterprise inclui um Registro de Esquema para usar e gerenciar esquemas.

Opções de comando:

--artifact-id valor
ID do esquema.
--set valor
O valor da regra de compatibilidade. Os valores permitidos são "NONE", "FULL", "FULL_TRANSITIVE", "FORWARD", "FORWARD_TRANSITIVE", "BACKWARD" e "BACKWARD_TRANSITIVE".

ibmcloud es schema-compatibility-rule

Exibir esquema ou regra de compatibilidade global.

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

Pré-requisitos: Esta operação é permitida apenas em instâncias Enterprise, pois apenas o plano Enterprise inclui um Registro de Esquema para usar e gerenciar esquemas. Use o sinalizador --artifact-id ou --global.

Opções de comando:

--artifact-id valor
Opcional. ID do esquema.
--global
Opcional. Exibir a regra de compatibilidade global.
--json
Opcional. Saída no formato JSON.

ibmcloud es schema-compatibility-rule-update

Alterar o esquema ou a regra de compatibilidade global.

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

Pré-requisitos: Esta operação é permitida apenas em instâncias Enterprise, pois apenas o plano Enterprise inclui um Registro de Esquema para usar e gerenciar esquemas. Use o sinalizador --artifact-id ou --global.

Opções de comando:

--artifact-id valor
Opcional. ID do esquema.
--global
Opcional. Alterar a regra de compatibilidade global.
--set valor
O valor da regra de compatibilidade. Os valores permitidos são "NONE", "FULL", "FULL_TRANSITIVE", "FORWARD", "FORWARD_TRANSITIVE", "BACKWARD" e "BACKWARD_TRANSITIVE".

ibmcloud es schema-compatibility-rule-delete

Excluir regra de compatibilidade de esquema.

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

Pré-requisitos: Esta operação é permitida apenas em instâncias Enterprise, pois apenas o plano Enterprise inclui um Registro de Esquema para usar e gerenciar esquemas.

Opções de comando:

--artifact-id valor
ID do esquema.
--force
Opcional. Excluir a regra de compatibilidade sem confirmação.