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: 顯示企業實例的供應參數。
-翻譯更新。
v2.1.1 2020 年 7 月 10 日 -將 whitelist 取代為 'allowlist'。
-固定顏色配置。
-翻譯更新。
v2.2.0 2020 年 8 月 3 日
  • 新增對鏡射功能的支援。
v2.2.1 2020 年 8 月 7 日 -init: 已精簡 IP 允許清單的顯示。
v2.3 2020 年 11 月 9 日 -已新增在主題上配置訊息審核的支援。
-init: 如果在佈建中指定了參數 kms_key_crn ,則顯示加密金鑰。
v2.3.2 2022 年 5 月 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-topicshelp 指令。
v2.5.0 2023 年 12 月 15 日 -已新增 schema-import 指令。
v2.6.0 2024 年 8 月 29 日
  • 新增了 schemasschema-createschemaschema-updateschema-delete schema-version schema-versionsschema-version-createschema-version-updateschema-version-deleteschema-compatibility-rule-create、*、schema-compatibility-ruleschema-compatibility-rule-updateschema-compatibility-rule-delete 指令。
v2.6.1 2024 年 11 月 1 日
  • 漏洞修復。
v2.6.2 2025 年 2 月 01 日
  • 漏洞修復。
v2.7.0 2025 年 2 月 25 日
  • 翻譯從 kafka 伺服器傳回的錯誤訊息。
  • 修正 broker-config 列印設定兩次。
v2.7.1 2025 年 5 月 01 日
  • 漏洞修復。
v2.7.3 2026 年 4 月 29 日
  • 漏洞修正。
  • 對無效參數處理的小變更。 如果未指定可選參數,無效參數可能會被忽略,而不是傳回錯誤。

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
分配管理系統 ID,指定時前面是否具有 '--broker' 旗標皆可。
--json(選用)
以 JSON 進行輸出格式化。

ibmcloud es broker-config

顯示分配管理系統的配置。

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

必要條件:無

指令選項

--broker value, -b value
分配管理系統 ID,指定時前面是否具有 '--broker' 旗標皆可。
--filter value, -f value(選用)
使用通配符 (*) 或帶正斜線 (/) 分隔符的正規表達式篩選組態清單。
--verbose, -v(選用)
顯示詳細配置資訊。
--json(選用)
以 JSON 進行輸出格式化。

ibmcloud es cluster

顯示集群的詳細信息,包括所有broker的詳細資訊和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 [key=value], -c [key=value]

以 [KEY=VALUE] 對的方式設定主題的設定選項。

如果未給定 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
消費者群組 ID。
--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
消耗者群組 ID
--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
消耗者群組 ID
--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
以逗號分隔的 regex 模式選取要鏡射的主題。 使用 '.*' 鏡映所有主題。
--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 schema-import

將一組綱目從 Zip 檔匯入登錄。

ibmcloud es schema-import [--file] ZIP_FILE_PATH

必要條件: 僅在「企業」實例上允許此作業,因為只有「企業」方案包含使用及管理綱目的「綱目登錄」。

指令選項

--file值,-f值
壓縮檔案路徑。

ibmcloud es 模式

列出登錄中的綱目。

ibmcloud es schemas [--json]

必要條件: 僅在「企業」實例上允許此作業,因為只有「企業」方案包含使用及管理綱目的「綱目登錄」。

指令選項

--json
選用。 以 JSON 進行輸出格式化。

ibmcloud es 模式創建

創建一個架構。

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 模式刪除

刪除架構。

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

必要條件: 僅在「企業」實例上允許此作業,因為只有「企業」方案包含使用及管理綱目的「綱目登錄」。 此架構必須處於 DISABLED 狀態。

指令選項

--artifact-id值
架構的 ID。
--force
選用。 刪除模式,無需確認。

ibmcloud es 架構版本

顯示模式的版本。

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

必要條件: 僅在「企業」實例上允許此作業,因為只有「企業」方案包含使用及管理綱目的「綱目登錄」。

指令選項

--artifact-id值
架構的 ID。
--json
選用。 以 JSON 進行輸出格式化。

ibmcloud es 架構版本創建

建立模式的新版本。

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 架構版本更新

更改架構版本的狀態。

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 架構版本刪除

刪除模式的版本。

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

必要條件: 僅在「企業」實例上允許此作業,因為只有「企業」方案包含使用及管理綱目的「綱目登錄」。 架構版本必須處於 DISABLED 狀態。

指令選項

--artifact-id值
架構工件的 ID。
--version 價值
待刪除版本。
--force
選用。 刪除架構版本而不進行確認。

ibmcloud es 架構相容性規則創建

建立架構兼容性規則。

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

必要條件: 僅在「企業」實例上允許此作業,因為只有「企業」方案包含使用及管理綱目的「綱目登錄」。

指令選項

--artifact-id值
架構的 ID。
--set 價值
相容性規則的值。 允許的值為「NONE」、「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 價值
相容性規則的值。 允許的值為「NONE」、「FULL」、「FULL_TRANSITIVE」、「FORWARD」、「FORWARD_TRANSITIVE」、「BACKWARD」和「BACKWARD_TRANSITIVE」。

ibmcloud es 架構相容性規則刪除

刪除架構兼容性規則。

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

必要條件: 僅在「企業」實例上允許此作業,因為只有「企業」方案包含使用及管理綱目的「綱目登錄」。

指令選項

--artifact-id值
架構的 ID。
--force
選用。 刪除相容性規則,無需確認。