IBM Cloud Logs CLI

IBM® Cloud Logs のコマンドラインインターフェース（CLI）を使用して、 IBM Cloud Logs インスタンスを管理できます。

前提条件

  • IBM Cloud CLI をインストールします。

  • 次のコマンドを実行して、 IBM Cloud Logs CLIプラグインをインストールします

    ibmcloud plugin install logs

    IBM Cloud CLI およびプラグインに対する更新が使用可能になると、コマンド・ラインで通知されます。 最新のコマンドを使用できるように、CLI をいつも最新の状態にしておいてください。 ibmcloud plugin list を実行すると、インストールされているすべてのプラグインの現行バージョンを表示できます。

  • ターゲットを絞るにはIBM Cloud Logsたとえば、次のいずれかのオプションを使用します。

    オプション1: 実行する ibmcloud logs config set 指示。

    ibmcloud logs config set service-url https://{API_endpoint}

    オプション 2： IBM Cloud Logs サービスのエンドポイント URL を含む環境変数をエクスポートします。

    export LOGS_URL=https://{API_endpoint}

    オプション 3: コマンドでサービス エンドポイントを設定します。

    ibmcloud logs --service-url https://{API_endpoint}

    {API_endpoint} は、インスタンス固有の API エンドポイントに置き換えてください。 APIエンドポイント情報は、IBM Cloud Logsのサービス詳細ページからコピーできます。UIからコピーできます。

コマンド

現在サポートされている IBM Cloud Logs CLIのバージョンは、 0.3.0 です。 他のバージョンがインストールされている場合は、インストールされているプラグインをアンインストールし、最新の IBM Cloud Logs CLIプラグインをインストールしてください。

ibmcloud cloud-logs と ibmcloud logs のどちらでも、 IBM Cloud Logs のCLIコマンドを実行できます。

IBM Cloud Logs アラートCLIコマンド
コマンド 説明
alert ID でアラートを取得します。
alert-create アラートを作成します。
alert-delete アラートを削除します。
alert-update アラートを更新します。
alerts アラートを一覧表示します。
IBM Cloud Logs アラート定義CLIコマンド
コマンド 説明
alert-definition IDによるアラート定義を取得する。
alert-definition-create アラート定義を作成する。
alert-definition-delete IDでアラート定義を削除する。
alert-definition-update IDによってアラート定義を更新する。
alert-definitions 警告の定義をリストアップする。
IBM Cloud Logs バックグラウンドクエリ（非同期アーカイブクエリ）CLIコマンド
コマンド 説明
background-query-cancel, bgq-cancel バックグラウンドクエリをキャンセルする。
background-query-create, bgq-create 非同期に処理されるバックグラウンドクエリを送信します。
background-query-data, bgq-data ログを検索するバックグラウンドクエリのデータ。
background-query-status, bgq-status バックグラウンドクエリのステータスを取得する。
IBM Cloud Logs データアクセスルールCLIコマンド
コマンド 説明
data-access-rule-create データアクセスルールを作成します。
data-access-rule-delete データ アクセス ルールを削除します。
data-access-rule-update データアクセスルールを更新します。
data-access-rules サービス・インスタンスのデータ・アクセス・ルールをIDで取得する。
IBM Cloud Logs データ使用 CLI コマンド
コマンド 説明
data-usage 毎日の詳細なデータ使用量を取得します。
data-usage-metrics-export-status データ使用状況メトリックのエクスポート ステータスを取得します。
data-usage-metrics-export-status-update データ使用メトリックのエクスポート ステータスを更新します。
IBM Cloud Logs エンリッチメントCLIコマンド
コマンド 説明
enrichment-create エンリッチメントを作成します。
enrichment-delete エンリッチメントを削除します。
enrichments すべてのエンリッチメントを一覧表示します。
IBM Cloud Logs Event Streams 統合CLIコマンド
コマンド 説明
event-stream-target-create IBM Event Streams for IBM Cloud。
event-stream-target-delete Event Streams IDによる統合を削除する。
event-stream-target-update Event Streams の統合を更新する。
event-stream-targets Event Streams のすべての連携を一覧表示します。
IBM Cloud Logs イベントからメトリクスCLIコマンドへ
コマンド 説明
events2metrics, e2m ID に基づいて、イベントからメトリクスの定義を取得します。
events2metrics-create, e2m-create イベントをメトリクス定義に作成します。
events2metrics-delete, e2m-delete ID に基づいて、イベントからメトリクスの定義を削除します。
events2metrics-list, e2m-list メトリクスの定義に対するイベントを一覧表示します。
events2metrics-update, e2m-update イベントをメトリクス定義に更新する。
IBM Cloud Logs アウトバウンド統合CLIコマンド
コマンド 説明
outgoing-webhook ID によってアウトバウンド統合を取得します。
outgoing-webhook-create アウトバウンド統合を作成します。
outgoing-webhook-delete アウトバウンド統合を削除します。
outgoing-webhook-update アウトバウンド統合を更新します。
outgoing-webhooks アウトバウンド統合を一覧表示します。
IBM Cloud Logs ポリシーのCLIコマンド
コマンド 説明
policies ポリシーを取得します。
policy ID を指定してポリシーを取得します。
policy-create 新規ポリシーを作成します。
policy-delete 既存のポリシーを削除します。
policy-update 既存のポリシーを更新します。
IBM Cloud Logs 問い合わせCLIコマンド
コマンド 説明
query クエリを実行してログを検索します。
IBM Cloud Logs ルールCLIコマンド
コマンド 説明
rule-group groupid に基づいてルールグループを取得します。
rule-group-create ルールグループを作成する。
rule-group-delete groupid に基づいてルールグループを削除します。
rule-group-update グループIDごとにルールグループを更新します。
rule-groups すべてのルール・グループを取得します。
IBM Cloud Logs CLIコマンドを見る
コマンド 説明
view ビューを ID 別に取得します。
view-create 新規ビューを作成します。
view-delete ビューを ID 別に削除します。
view-update 既存のビューを置き換えます。
views 会社のすべての公開ビューをリストします。
IBM Cloud Logs ビューフォルダCLIコマンド
コマンド 説明
view-folder ビューフォルダを取得します。
view-folder-create ビューフォルダを作成します。
view-folder-delete ビューフォルダを ID 別に削除します。
view-folder-update 既存のビューフォルダを置き換えます。
view-folders リスト・ビューのフォルダー。
IBM Cloud Logs 拡張機能の CLI コマンド
コマンド 説明
extensions ID に基づいて拡張機能を取得します。
extension-deployment 拡張機能ごとにデプロイの詳細を取得します。
extension-deployment-delete 拡張機能のデプロイを削除します。
extension-deployment-managep 拡張機能をデプロイするか、デプロイ内容を更新します。
extensions 拡張機能の一覧を取得する。
IBM Cloud Logs 追加のCLIコマンド
コマンド 説明
config 永続的なコンフィギュレーションをコントロールする。
help ヘルプ情報を表示する。

これらのコマンドの使用方法の詳細については、 IBM Cloudそして走る ibmcloud logs command_name -h。 例えば、ibmcloud logs views -h です。