Note
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
alerts 内の コマンド グループには、アラートの取得、作成、更新、および削除操作を実行するコマンドが含まれています。 アラートは、クエリを定期的に実行し、その結果の条件を評価し、条件が満たされた場合に 1 人以上のユーザーや通知先に通知する Databricks SQL オブジェクトです。
Databricks SQL アラートを参照してください。
databricks でのアラート作成
アラートを作成します。
databricks alerts create [flags]
オプション
--auto-resolve-display-name
true の場合、アラートの表示名の競合を自動的に解決します。
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path
Examples
次の例では、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 アラートの削除
アラートをごみ箱に移動します。 ごみ箱に入ったアラートは、検索ビューやリスト ビューからすぐに消え、トリガーできなくなります。 UI を使用して、ゴミ箱にあるアラートを復元できます。 ごみ箱にあるアラートは、30 日後に完全に削除されます。
databricks alerts delete ID [flags]
Arguments
ID
削除するアラートの ID。
オプション
Examples
次の例では、ID でアラートを削除します。
databricks alerts delete 12345
databricks アラートの取得
アラートを取得します。
databricks alerts get ID [flags]
Arguments
ID
取得対象のアラートID。
オプション
Examples
次の例では、ID によってアラートを取得します。
databricks alerts get 12345
databricks アラートの一覧
ユーザーがアクセスできるアラートを作成時間順に一覧表示します。
Important
このコマンドを 10 回以上同時に実行すると、調整、サービスの低下、または一時的な禁止が発生する可能性があります。
databricks alerts list [flags]
オプション
--page-size int
ページごとに返されるアラートの最大数。
--page-token string
結果の次のページを取得するトークン。
Examples
次の例では、すべてのアラートを一覧表示します。
databricks alerts list
以下の例では、ページ分割されたアラートの一覧を示します。
databricks alerts list --page-size 10
Databricks アラート更新
アラートを更新します。
databricks alerts update ID UPDATE_MASK [flags]
Arguments
ID
更新するアラートの ID。
UPDATE_MASK
フィールド マスクは 1 つの文字列で、複数のフィールドをコンマで区切る必要があります (スペースなし)。 フィールド パスはリソース オブジェクトに対する相対パスであり、ドット (.) を使用してサブフィールド ( author.given_name など) を移動します。 コレクション フィールド全体のみを指定できるため、シーケンス フィールドまたはマップ フィールド内の要素の指定は許可されません。 フィールド名は、リソース フィールド名と完全に一致する必要があります。
アスタリスク (*) フィールド マスクは、完全な置換を示します。 今後 API が変更されると意図しない結果が生じる可能性があるため、更新されるフィールドを常に明示的に一覧表示し、ワイルドカードを使用しないようにすることをお勧めします。
オプション
--auto-resolve-display-name
true の場合、アラートの表示名の競合を自動的に解決します。
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path
Examples
次の例では、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 文字列
出力ログを書き込むファイルを表す文字列。 このフラグが指定されていない場合、既定では stderr に出力ログが書き込まれます。
--log-format 形式
ログ形式の種類、 text 、または json。 既定値は text です。
--log-level 文字列
ログ形式レベルを表す文字列。 指定しない場合、ログ形式レベルは無効になります。
-o, --output 型
コマンド出力の種類( text または json)。 既定値は text です。
-p, --profile 文字列
コマンドの実行に使用する ~/.databrickscfg ファイル内のプロファイルの名前。 このフラグが指定されていない場合は、存在する場合は、 DEFAULT という名前のプロファイルが使用されます。
--progress-format 形式
進行状況ログを表示する形式: default、 append、 inplace、または json
-t, --target 文字列
該当する場合は、使用するバンドル ターゲット