Event Streams CLI 参考

如果您想了解如何为 Event Streams 安装CLI，请参阅 Event Streams CLI入门。

更改日志

Event Streams的更新日志CLI 插件
版本	发布日期	更改
v1.0	2019 年 5 月 12 日	Event Streams CLI的首次发布。
v1.0.1	2019 年 5 月 27 日	-在不使用 init 的情况下运行命令时改进了错误消息。 -在 init 期间排序的实例列表。 -转换更新。
v2.0	2019 年 8 月 21 日	-init: 已除去服务密钥需求。 -已添加 group-delete 命令。帮助文本的更新翻译。
v2.1	2020 年 6 月 24 日	-init: 显示了 Enterprise 实例的供应参数。 -转换更新。
v2.1.1	2020 年 7 月 10 日	-将 `whitelist` 替换为 "allowlist"。 -固定颜色配置。 -转换更新。
v2.2.0	3 2020 年 8 月	新增镜像功能支持。
v2.2.1	7 2020 年 8 月	-init: 已优化 IP 允许列表的显示。
v2.3	9 2020 年 11 月	-添加了对在主题上配置消息审计的支持。 -init: 如果在供应中指定了参数 kms_key_crn ，那么显示加密密钥。
v2.3.2	5 2022 年 5 月	新增对 Mac OS X M1/ARM. 的支持——init：如果配置中指定了参数 `cos_bucket_crn`，则显示 Object Storage 存储桶。
v2.4.0	2023 年 2 月 28 日	-已将 Kafka 版本添加到 `ibmcloud es cluster`。 -已更新为 1.9.6。
v2.4.1	2023 年 12 月 5 日	-添加了 `mirroring-active-topics` 和 `help` 命令。
v2.5.0	2023 年 12 月 15 日	-添加了 `schema-import` 命令。
v2.6.0	2024 年 8 月 29 日	添加了 `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`，和 `schema-compatibility-rule-delete` 命令。
v2.6.1	2024 年 11 月 01 日	漏洞修复。
v2.6.2	2025年2月1日	漏洞修复。
v2.7.0	2025年2月25日	Kafka服务器返回的错误消息为 translated. ——修复了 `broker-config` 打印设置重复的问题。

ibmcloud es init

初始化 Event Streams 插件。

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

先决条件：无

命令选项：

--instance-name value, -i value（可选）: Event Streams 实例的名称。
--api-url value, -a value（可选）: Event Streams 实例的 Kafka 管理 URL。

ibmcloud es broker

显示特定经纪人的详细信息。

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

先决条件：无

命令选项：

--broker value, -b value: 代理程序标识，前面的“--broker”标志可指定或不指定。
--json（可选）: 输出格式为 JSON。

ibmcloud es broker-config

显示代理程序的配置。

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

先决条件：无

命令选项：

--broker value, -b value: 代理程序标识，前面的“--broker”标志可指定或不指定。
--filter value, -f value（可选）: 使用通配符（*）或正则表达式（以斜线（/）为分隔符）过滤配置列表。
--verbose, -v（可选）: 显示详细配置信息。
--json（可选）: 输出格式为 JSON。

ibmcloud es cluster

显示集群的详细信息，包括所有代理的详细信息和Kafka版本。

ibmcloud es cluster [--json]

先决条件：无

命令选项：

--json（可选）: 输出格式为 JSON。

ibmcloud es topic

显示主题的详细信息。

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

先决条件：无

命令选项：

--name value, -n value: 主题名称。
--json（可选）: 输出格式为 JSON。

ibmcloud es topic-create

创建新主题。

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

先决条件：无

命令选项：

--name value, -n value

主题名称。

--partitions value, -p value

设置主题的分区数。

--config KEY=VALUE, -c KEY=VALUE（可选）

将主题的配置选项设置为 KEY=VALUE 对。

可以指定多个 --config 选项。每个“--config”选项可以指定一个以分号分隔的分配列表。以下列表显示有效的配置密钥:

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

ibmcloud es topic-delete

删除主题。

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

先决条件：无

命令选项：

--name value, -n value: 主题名称。
--force, -f（可选）: 删除而不确认。

ibmcloud es topic-delete-records

删除主题中给定偏移量的记录。

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

先决条件：无

命令选项：

--name value, -n value: 主题名称。
--partition-offset PARTITION:OFFSET, -p PARTITION:OFFSET: 要从中删除记录的分区和偏移量，格式为 PARTITION:OFFSET。; 可以指定多个 --partition-offset 选项，也可以使用分号定界符指定多个 PARTITION:OFFSET 对，并使用引号将这些对括起：'PARTITION1:OFFSET1;PARTITION2:OFFSET2;PARTITION3:OFFSET3'。
--force, -f（可选）: 删除记录而不确认。

ibmcloud es topic-partitions-set

设置主题的分区。

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

先决条件：无

命令选项：

--name value, -n value: 主题名称。
--partitions value, -p value: 设置主题的分区数。

ibmcloud es topic-update

更新主题的配置。

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

先决条件：无

命令选项：

--name value, -n value

主题名称。

--config 键 [=值], -c 键 [=值]

为该主题设置一个配置选项，以[键=值对]的形式。

如果未指定VALUE，则应指定 '--default' 标志，以表示将配置值重置为默认值。可指定多个 '--config' 选项。每个“--config”选项可以指定一个以分号分隔的分配列表。以下列表显示有效的配置密钥:

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

--default, -d（可选）

将使用 '--config' 指定的每个配置参数重置为默认值。

ibmcloud es topics

列出主题。

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

先决条件：无

命令选项：

--filter value, -f value（可选）: 主题名称。
--json（可选）: 将输出格式设置为 JSON。最多可返回 1000 个主题。

ibmcloud es group

显示使用者组的详细信息。

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

前提条件：无

命令选项：

--group value, -g value: 使用者组标识。
--json（可选）: 将输出格式设置为 JSON。

ibmcloud es group-reset

重置使用者组的偏移量。

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

先决条件：无

命令选项：

--group value, -g value: 使用者组标识。
--topic value, -t value: 主题名称。仅应用于此主题。如果提供了 '--all-topics' 标记，则省略。
--all-topics, -a: 应用于分配给组的所有主题。如果提供了 '--topic' 标记，则省略。
--mode value, -m value: 以下值之一：最早、最晚或日期时间。
--value value, -v value: 用于根据“--mode”重置偏移量的值。针对“--mode”值“earliest”和“latest”，请省略此项。 ‘datetime’：使用‘ YYYY-MM-DDTHH:mm:SS.sss [±hh:mm|Z] ’。
--dry-run（可选）: 显示结果，但不实施更改。
--execute（可选）: 执行对偏移量的更改。
--json（可选）: 将输出格式设置为 JSON。

ibmcloud es groups

列出使用者组。

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

先决条件：无

命令选项：

--filter value, -f value（可选）: 可选。使用通配符（*）或正则表达式（以斜线（/）为分隔符）过滤消费者群体列表。
--json（可选）: 将输出格式设置为 JSON。最多返回 1000 个组。

ibmcloud es group-delete

删除使用者组。

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

先决条件：无

命令选项：

--group value, -g value: 使用者组标识。
--force, -f（可选）: 删除组而不确认。

ibmcloud es mirroring-topic-selection

列出镜像主题选择。

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

先决条件: 已在 Event Streams 实例上启用镜像。Event Streams 插件已配置为通过 ibmcloud es init 连接到镜像目标集群。

命令选项：

--json（可选）: 将输出格式设置为 JSON。

ibmcloud es mirroring-topic-selection-set

替换镜像主题选择。

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

先决条件: 已在 Event Streams 实例上启用镜像。Event Streams 插件已配置为通过 ibmcloud es init 连接到镜像目标集群。

命令选项：

--select value: 选择要反映的主题，以逗号分隔的正则表达式模式显示。使用“.*”可镜像所有主题。
--none: 清除当前选择的主题（禁用主题镜像）。
--force: 可选。替换镜像主题选择而不进行确认。

ibmcloud es mirroring-active-topics

获取正在主动生成镜像的主题。

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

先决条件: 已在 Event Streams 实例上启用镜像。Event Streams 插件已配置为通过 ibmcloud es init 连接到镜像目标集群。

命令选项：

--json（可选）: 将输出格式设置为 JSON。

ibmcloud es 帮助

显示命令的帮助，或列出所有命令。

ibmcloud es help [COMMAND]

先决条件：无

命令选项：

command（可选）: 显示命令的帮助。

ibmcloud es 模式-导入

将一组模式从 zip 文件导入到注册表中。

ibmcloud es schema-import [--file] ZIP_FILE_PATH

先决条件: 仅允许在企业实例上执行此操作，因为只有企业套餐包含用于使用和管理模式的模式注册表。

命令选项：

--file 值，-f 值: Zip 文件路径。

ibmcloud es 架构

列出注册表中的模式。

ibmcloud es schemas [--json]

先决条件: 仅允许在企业实例上执行此操作，因为只有企业套餐包含用于使用和管理模式的模式注册表。

命令选项：

--json: 可选。将输出格式设置为 JSON。

ibmcloud es schema-create

创建模式。

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

先决条件: 仅允许在企业实例上执行此操作，因为只有企业套餐包含用于使用和管理模式的模式注册表。

命令选项：

--artifact-id 值: 可选。要创建的模式工件的 ID。如果未提供，则会生成一个 ID。
--file 价值: 包含要创建的模式的 JSON 定义的文件路径。
--json: 可选。将输出格式设置为 JSON。

ibmcloud es 模式

显示模式的相关信息。

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

先决条件: 仅允许在企业实例上执行此操作，因为只有企业套餐包含用于使用和管理模式的模式注册表。

命令选项：

--artifact-id 值: 模式的 ID。
--json: 可选。将输出格式设置为 JSON。

ibmcloud es 架构更新

更改模式的状态。

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

先决条件: 仅允许在企业实例上执行此操作，因为只有企业套餐包含用于使用和管理模式的模式注册表。

命令选项：

--artifact-id 值: 模式的 ID。
--set 价值: 模式的新状态，必须为“ENABLED（启用）”或“DISABLED（禁用）”。

ibmcloud es schema-delete

删除模式。

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

先决条件: 仅允许在企业实例上执行此操作，因为只有企业套餐包含用于使用和管理模式的模式注册表。模式必须处于停用状态。

命令选项：

--artifact-id 值: 模式的 ID。
--force: 可选。删除模式，无需确认。

ibmcloud es 模式版本

显示模式版本。

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

先决条件: 仅允许在企业实例上执行此操作，因为只有企业套餐包含用于使用和管理模式的模式注册表。

命令选项：

--artifact-id 值: 模式的 ID。
--json: 可选。将输出格式设置为 JSON。

ibmcloud es schema-version-create

创建一个新版本的架构。

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

先决条件: 仅允许在企业实例上执行此操作，因为只有企业套餐包含用于使用和管理模式的模式注册表。

命令选项：

--artifact-id 值: 要创建新版本的模式工件的 ID。
--file 价值: 包含要创建的模式版本的 JSON 定义的文件路径。
--json: 可选。将输出格式设置为 JSON。

ibmcloud es 模式版本

显示模式版本信息。

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

先决条件: 仅允许在企业实例上执行此操作，因为只有企业套餐包含用于使用和管理模式的模式注册表。使用 --artifact-id 和 --version 标记，或 --global-id 标记。

命令选项：

--artifact-id 值: 模式工件的 ID。
--version 价值: 要显示的版本。
--global-id 值: 要显示的模式版本的全局 ID。
--json: 可选。将输出格式设置为 JSON。

ibmcloud es schema-version-update

更改模式版本的状态。

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

先决条件: 仅允许在企业实例上执行此操作，因为只有企业套餐包含用于使用和管理模式的模式注册表。

命令选项：

--artifact-id 值: 模式工件的 ID。
--version 价值: 待更新版本。
--set 价值: 模式版本的新状态，必须为 "ENABLED "或 "DISABLED"。
--json: 可选。将输出格式设置为 JSON。

ibmcloud es schema-version-delete

删除架构的某个版本。

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

先决条件: 仅允许在企业实例上执行此操作，因为只有企业套餐包含用于使用和管理模式的模式注册表。模式版本必须处于停用状态。

命令选项：

--artifact-id 值: 模式工件的 ID。
--version 价值: 要删除的版本。
--force: 可选。删除模式版本，无需确认。

ibmcloud es schema-compatibility-rule-create

创建模式兼容性规则。

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

先决条件: 仅允许在企业实例上执行此操作，因为只有企业套餐包含用于使用和管理模式的模式注册表。

命令选项：

--artifact-id 值: 模式的 ID。
--set 价值: 兼容性规则的值。允许的值有“无”、"FULL"、"FULL_TRANSITIVE"、"FORWARD"、"FORWARD_TRANSITIVE"、"BACKWARD "和 "BACKWARD_TRANSITIVE"。

ibmcloud es 模式兼容性规则

显示模式或全局兼容性规则。

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

先决条件: 仅允许在企业实例上执行此操作，因为只有企业套餐包含用于使用和管理模式的模式注册表。使用 --artifact-id 或 --global 标记。

命令选项：

--artifact-id 值: 可选。模式的 ID。
--global: 可选。显示全局兼容性规则。
--json: 可选。将输出格式设置为 JSON。

ibmcloud es 模式兼容性规则更新

更改模式或全局兼容性规则。

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

先决条件: 仅允许在企业实例上执行此操作，因为只有企业套餐包含用于使用和管理模式的模式注册表。使用 --artifact-id 或 --global 标记。

命令选项：

--artifact-id 值: 可选。模式的 ID。
--global: 可选。更改全局兼容性规则。
--set 价值: 兼容性规则的值。允许的值有“无”、"FULL"、"FULL_TRANSITIVE"、"FORWARD"、"FORWARD_TRANSITIVE"、"BACKWARD "和 "BACKWARD_TRANSITIVE"。

ibmcloud es schema-compatibility-rule-delete

删除模式兼容性规则。

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

先决条件: 仅允许在企业实例上执行此操作，因为只有企业套餐包含用于使用和管理模式的模式注册表。

命令选项：

--artifact-id 值: 模式的 ID。
--force: 可选。删除兼容性规则，无需确认。