alerts-v2 命令群組

備註

此資訊適用於 Databricks CLI 版本 0.205 及以上。 Databricks CLI 處於 公開預覽狀態

Databricks CLI 的使用受限於 Databricks 授權Databricks 隱私權聲明,包括任何使用數據條款。

alerts-v2 Databricks CLI 中的指令群組允許你管理 SQL 警報。 警示會定期執行查詢,評估結果的條件,並在條件達成時通知一位或多位使用者及/或通知目的地。

Databricks Alerts-V2 create-alert

建立警示。

databricks alerts-v2 create-alert DISPLAY_NAME QUERY_TEXT WAREHOUSE_ID EVALUATION SCHEDULE [flags]

引數

DISPLAY_NAME

    警報的顯示名稱。

QUERY_TEXT

    要執行的查詢文字。

WAREHOUSE_ID

    附帶在警示上的 SQL 倉庫 ID。

EVALUATION

    警報的評估條件。

SCHEDULE

    執行警報查詢的排程。

選項

--custom-description string

    警示的自訂描述。

--custom-summary string

    警示的自訂摘要。

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

--parent-path string

    包含警報資料夾的工作區路徑。

--run-as-user-name string

    這些程式會以服務主體的使用者名稱或應用程式 ID 執行。

全域旗標

Examples

下列範例會使用 JSON 檔案建立警示:

databricks alerts-v2 create-alert "High CPU Alert" "SELECT cpu_usage FROM metrics" "abc123" @evaluation.json @schedule.json --json @alert.json

Databricks Alerts-V2 Get-Alert

取得警示。

databricks alerts-v2 get-alert ID [flags]

引數

ID

    警報的UUID需要取回。

選項

全域旗標

Examples

下列範例會依識別碼獲取警示:

databricks alerts-v2 get-alert 12345678-1234-1234-1234-123456789012

Databricks alerts-v2 list-alerts

列出警示。 會獲得一份依創建時間排序的警示清單,供使用者存取。

databricks alerts-v2 list-alerts [flags]

引數

None

選項

--page-size int

    回傳警報次數最多。

--page-token string

    從前一個清單呼叫中取得下一頁的頁面標記。

全域旗標

Examples

以下範例列出所有可存取的警示:

databricks alerts-v2 list-alerts

Databricks alerts-v2 trash-alert

刪除警報。 將警示移至垃圾桶。 被丟棄的警報會立即從列表檢視中消失,且無法再觸發。 您可以透過UI還原被刪除的警示。 被刪除的警示會在 30 天後永久刪除。

databricks alerts-v2 trash-alert ID [flags]

引數

ID

    垃圾警報的UUID。

選項

--purge

    是否要永久刪除警報。

全域旗標

Examples

以下範例會丟棄警報:

databricks alerts-v2 trash-alert 12345678-1234-1234-1234-123456789012

以下範例會永久刪除警示:

databricks alerts-v2 trash-alert 12345678-1234-1234-1234-123456789012 --purge

Databricks alerts-v2 update-alert

更新警示。

databricks alerts-v2 update-alert ID UPDATE_MASK DISPLAY_NAME QUERY_TEXT WAREHOUSE_ID EVALUATION SCHEDULE [flags]

引數

ID

    UUID 識別警報。

UPDATE_MASK

    欄位遮罩指定要更新哪些欄位。 使用逗號分隔的欄位名稱。 用來 * 更新所有欄位。

DISPLAY_NAME

    警報的顯示名稱。

QUERY_TEXT

    要執行的查詢文字。

WAREHOUSE_ID

    附帶在警示上的 SQL 倉庫 ID。

EVALUATION

    警報的評估條件。

SCHEDULE

    執行警報查詢的排程。

選項

--custom-description string

    警示的自訂描述。

--custom-summary string

    警示的自訂摘要。

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

--parent-path string

    包含警報資料夾的工作區路徑。

--run-as-user-name string

    這些程式會以服務主體的使用者名稱或應用程式 ID 執行。

全域旗標

Examples

以下範例更新警示的顯示名稱:

databricks alerts-v2 update-alert 12345678-1234-1234-1234-123456789012 display_name "Updated Alert Name" "SELECT cpu_usage FROM metrics" "abc123" @evaluation.json @schedule.json

全域旗標

--debug

  是否要啟用偵錯記錄。

-h--help

    顯示 Databricks CLI、相關命令群組或相關命令的幫助說明。

--log-file 字串

    字串,表示要寫入輸出記錄檔的檔案。 若未指定此旗標,則預設值是將輸出記錄寫入 stderr。

--log-format 格式

    記錄格式類型,textjson。 預設值為 text

--log-level 字串

    表示日誌格式層級的字串。 若未指定,則日誌的格式層級功能將被停用。

-o, --output 類型

    指令輸出類型,textjson。 預設值為 text

-p, --profile 字串

    用於執行命令的~/.databrickscfg檔案中的配置檔名稱。 如果未指定此旗標,則如果存在,則會使用名為 DEFAULT 的配置檔。

--progress-format 格式

    顯示進度記錄的格式:default、、appendinplace、 或json

-t, --target 字串

    如果適用,要使用的套件組合目標