Event Streams CLI リファレンス
Event Streams用の CLI のインストール方法については、Event Streams CLI の入門を参照してください。
変更ログ
| バージョン | リリース日 | 変更 |
|---|---|---|
| v1.0 | 2019 年 5 月 12 日 |
|
| v1.0.1 | 2019 年 5 月 27 日 | -init を指定せずにコマンドを実行した場合のエラー・メッセージが改善されました。 -init 中にソートされたインスタンスのリスト。 -変換の更新。 |
| v2.0 | 2019 年 8 月 21 日 |
-init: サービス・キー要件が削除されました。
|
| v2.1 | 2020 年 6 月 24 日 |
|
| v2.1.1 | 2020 年 7 月 10 日 |
|
| v2.2.0 | 2020 年 8 月 3 日 |
|
| v2.2.1 | 2020 年 8 月 7 日 |
|
| v2.3 | 2020 年 11 月 9 日 |
-トピックでメッセージ監査を構成するためのサポートが追加されました。
|
| v2.3.2 | 2022 年 5 月 5 日 |
|
| v2.4.0 | 2023 年 2 月 28 日 |
|
| v2.4.1 | 2023 年 12 月 5 日 |
|
| v2.5.0 | 2023 年 12 月 15 日 |
|
| v2.6.0 | 2024年8月29日 |
|
| v2.6.1 | 01 11月 2024 |
|
| v2.6.2 | 2025年2月1日 |
|
| v2.7.0 | 2025年2月25日 |
|
| v2.7.1 | 01 2025年5月 |
|
| 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 値、-i 値 (オプション)
- Event Streams インスタンスの名前。
- --api-url 値、-a 値 (オプション)
- Event Streams インスタンスの Kafka 管理 URL。
ibmcloud es broker
特定のブローカーの詳細を表示する。
ibmcloud es broker [--broker] ID [--json]
前提条件: なし
コマンド・オプション:
- --broker 値、-b 値
- 前に「--broker」フラグを付けて指定することも、付けずに指定することもできるブローカー ID。
- --json (オプション)
- JSON 出力フォーマット。
ibmcloud es broker-config
ブローカーの構成を表示します。
ibmcloud es broker-config [--broker] ID [--filter FILTER] [--verbose] [--json]
前提条件: なし
コマンド・オプション:
- --broker 値、-b 値
- 前に「--broker」フラグを付けて指定することも、付けずに指定することもできるブローカー ID。
- --filter 値、-f 値 (オプション)
- ワイルドカード (*) またはスラッシュ (/) 区切り文字付きの正規表現を使用して、構成のリストをフィルタリングします。
- --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 値、-n 値
- トピック名。
- --json (オプション)
- JSON 出力フォーマット。
ibmcloud es topic-create
新規トピックを作成します。
ibmcloud es topic-create [--name] TOPIC_NAME [--partitions PARTITIONS] [--config KEY=VALUE[;KEY=VALUE]* ]*
前提条件: なし
コマンド・オプション:
- --name 値、-n 値
-
トピック名。
- --partitions 値、-p 値
-
トピックのパーティションの数を設定します。
- --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 値、-n 値
- トピック名。
- --force、-f (オプション)
- 確認なしで削除します。
ibmcloud es topic-delete-records
指定されたオフセットのレコードをトピックから削除します。
ibmcloud es topic-delete-records [--name] TOPIC_NAME [--partition-offset PARTITION:OFFSET[;PARTITION:OFFSET]* ]* [--force]
前提条件: なし
コマンド・オプション:
- --name 値、-n 値
- トピック名。
- --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 値、-n 値
- トピック名。
- --partitions 値、-p 値
- トピックのパーティションの数を設定します。
ibmcloud es topic-update
トピックの構成を更新します。
ibmcloud es topic-update [--name] TOPIC_NAME --config KEY[=VALUE][;KEY[=VALUE]]* [--default]
前提条件: なし
コマンド・オプション:
- --name 値、-n 値
-
トピック名。
- --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 値、-f 値 (オプション)
- トピック名。
- --json (オプション)
- JSON で出力をフォーマットします。 最大で 1000 件のトピックが返されます。
ibmcloud es group
コンシューマー・グループの詳細を表示します。
ibmcloud es group [--group] GROUP_ID [--json]
> 前提条件: なし
コマンド・オプション:
- --group 値、-g 値
- コンシューマー・グループ 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 値、-g 値
- コンシューマー・グループ ID
- --topic 値、-t 値
- トピック名。 このトピックにのみ適用します。 「-- all-topics」フラグを指定した場合は省略します。
- --all-topics, -a
- グループに割り当てられているすべてのトピックに適用します。 「-- topic」フラグが指定されている場合は省略します。
- --mode 値、-m 値
- 「earliest」、「latest」、または「datetime」のいずれかの値です。
- --value 値、-v 値
- 「--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 値、-f 値 (オプション)
- オプション。 ワイルドカード (*) またはスラッシュ (/) 区切り文字付きの正規表現を使用して、コンシューマー・グループのリストをフィルタリングします。
- --json (オプション)
- JSON で出力をフォーマットします。 最大で 1000 個のグループが返されます。
ibmcloud es group-delete
コンシューマー・グループを削除します。
ibmcloud es group-delete [--group] GROUP_ID [--force]
前提条件: なし
コマンド・オプション:
- --group 値、-g 値
- コンシューマー・グループ 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 値
- コンマ区切りの正規表現パターンとしてミラーリングするトピックを選択します。 すべてのトピックをミラーリングするには、「.*」を使用します。
- --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]
前提条件: なし
コマンド・オプション:
- コマンド (オプション)
- コマンドのヘルプを表示します。
ibmcloud es スキーマ-インポート
スキーマのセットを zip ファイルからレジストリーにインポートします。
ibmcloud es schema-import [--file] ZIP_FILE_PATH
前提条件: この操作は、エンタープライズ・インスタンスでのみ許可されます。これは、エンタープライズ・プランにのみ、スキーマを使用および管理するためのスキーマ・レジストリーが含まれているためです。
コマンド・オプション:
- --file値、-f値
- Zip ファイル・パス。
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 で出力をフォーマットします。
IBMクラウド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 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
- オプション。 確認なしで互換性ルールを削除する。