system-commands
システムに登録されたクエリコマンドの一覧と各コマンドの詳細情報を照会します。
コマンドプロパティ
| 項目 | 説明 |
|---|---|
| コマンドタイプ | ドライバークエリ |
| 必要な権限 | なし |
| ライセンス使用量 | 集計しない |
| 並列実行 | 非対応 |
| 分散実行 | 非対応 |
構文
system-commands
オプション
なし
出力フィールド
| フィールド | タイプ | 説明 |
|---|---|---|
| name | string | クエリコマンドの名前 |
| description | string | クエリコマンドの説明 |
| options | map | クエリコマンド実行時に入力できるオプション。各オプションの必須フラグ、表示名、説明を含みます。 |
| outputs | map | クエリコマンド実行時に出力されるフィールドと説明 |
| usage | string | クエリコマンドの使用例 |
| display_group | string | クエリコマンドが属するグループ(Maestro、Sonar、Forensicなど) |
| display_name | string | クエリコマンドの表示名 |
エラーコード
パースエラー
該当なし
ランタイムエラー
該当なし
説明
system-commandsコマンドは、システムに登録されたすべてのクエリコマンドの一覧と各コマンドの詳細情報を照会します。セッションのロケール設定に従い、説明・オプション・出力フィールドの情報が該当言語で返されます。
optionsフィールドは各オプションについて、必須フラグ(required)、表示名(display_name)、説明(description)をマップ形式で返します。outputsフィールドも同じ構造で各出力フィールドの情報を返します。
使用例
-
すべてのクエリコマンド一覧を照会する
system-commandsシステムに登録されたすべてのクエリコマンドの名前と詳細情報を照会します。
-
特定コマンドの情報を照会する
system-commands | search name == "stats"statsコマンドの説明、オプション、出力フィールド情報を照会します。 -
Sonarコマンドのみ照会する
system-commands | search display_group == "Sonar"Sonarグループに属するクエリコマンドのみを照会します。