alerts コマンド グループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI は パブリック プレビュー段階です。
Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。
Databricks CLI内のalertsコマンド グループには、アラートの取得、作成、更新、および削除操作を実行するコマンドが含まれています。アラートは、クエリを定期的に実行し、その結果の条件を評価し、条件が満たされた場合に 1 人以上のユーザーや通知先に通知する Databricks SQL オブジェクトです。「 Databricks SQL アラート」を参照してください。
databricks alerts create
アラートを作成します。
databricks alerts create [flags]
オプション
--auto-resolve-display-name
true の場合、アラートの表示名の競合を自動的に解決します。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path
例
次の例では、JSON を使用してアラートを作成します。
databricks alerts create --json '{"name": "High CPU Alert", "query_id": "12345", "condition": {"op": "GREATER_THAN", "operand": {"column": {"name": "cpu_usage"}}, "threshold": {"value": {"double_value": 80}'
次の例では、JSON ファイルを使用してアラートを作成します。
databricks alerts create --json @alert.json
databricks alerts delete
アラートをゴミ箱に移動します。ごみ箱に入れられたアラートは、検索やリストビューからすぐに消え、トリガーできなくなります。ゴミ箱に入れられたアラートは、UI から復元できます。ごみ箱に入れられたアラートは、30 日後に完全に削除されます。
databricks alerts delete ID [flags]
引数
ID
削除するアラートの ID。
オプション
例
次の例では、アラートを ID で削除します。
databricks alerts delete 12345
databricks alerts get
アラートを受け取ります。
databricks alerts get ID [flags]
引数
ID
取得するアラートの ID。
オプション
例
次の例では、ID でアラートを取得します。
databricks alerts get 12345
databricks alerts list
ユーザーがアクセスできるアラートを、作成時刻順に一覧表示します。
このコマンドを同時に 10 回以上実行すると、スロットリング、サービスの低下、または一時的な禁止が発生する可能性があります。
databricks alerts list [flags]
オプション
--page-size int
ページごとに返されるアラートの最大数。
--page-token string
結果の次のページを取得するためのトークン。
例
次の例は、すべてのアラートをリストします。
databricks alerts list
次の例は、ページネーションを含むアラートを一覧表示します。
databricks alerts list --page-size 10
databricks alerts update
アラートを更新します。
databricks alerts update ID UPDATE_MASK [flags]
引数
ID
更新するアラートの ID。
UPDATE_MASK
フィールドマスクは、複数のフィールドをカンマ(スペースなし)で区切った単一の文字列にする必要があります。フィールドパスはリソースオブジェクトを基準にしており、ドット(.)を使用してサブフィールド( author.given_nameなど)を移動します。シーケンスフィールドまたはマップフィールド内の要素の指定は、コレクションフィールド全体のみを指定できるため、許可されません。フィールド名は、リソース・フィールド名と完全に一致する必要があります。
アスタリスク (*) フィールド マスクは、完全な置換を示します。更新されるフィールドを常に明示的にリストし、将来 API が変更された場合に意図しない結果が生じる可能性があるため、ワイルドカードの使用を避けることをお勧めします。
オプション
--auto-resolve-display-name
true の場合、アラートの表示名の競合を自動的に解決します。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path
例
次の例では、JSON を使用してアラートを更新します。
databricks alerts update 12345 "name,condition" --json '{"name": "Updated Alert Name", "condition": {"op": "GREATER_THAN", "operand": {"column": {"name": "cpu_usage"}}, "threshold": {"value": {"double_value": 90}'
次の例では、JSON ファイルを使用してアラートを更新します。
databricks alerts update 12345 "name,condition" --json @update-alert.json
グローバルフラグ
--debug
デバッグログを有効にするかどうか。
-h または --help
Databricks CLI、関連するコマンド グループ、または関連するコマンドのヘルプを表示します。
--log-file string
出力ログの書き込み先となるファイルを表す文字列。このフラグが指定されていない場合、デフォルトでは出力ログが stderr に書き込まれます。
--log-format format
ログ・フォーマット・タイプ ( text または json) 。デフォルト値は textです。
--log-level string
ログ形式レベルを表す文字列。指定しない場合、ログ・フォーマット・レベルは使用不可になります。
-o, --output タイプ
コマンド出力タイプ text または json。デフォルト値は textです。
-p, --profile string
コマンドの実行に使用する ~/.databrickscfg ファイル内のプロファイルの名前。このフラグが指定されていない場合、存在する場合は、 DEFAULT という名前のプロファイルが使用されます。
--progress-format format
進行状況ログを表示する形式: default、 append、 inplace、 json
-t, --target string
該当する場合は、使用するバンドル・ターゲット