Note
此資訊適用於 Databricks CLI 版本 0.205 及以上。 Databricks CLI 處於 公開預覽狀態。
Databricks CLI 的使用受限於 Databricks 授權 和 Databricks 隱私權聲明,包括任何使用數據條款。
alerts
Databricks CLI 中的指令群組包含執行 get 、建立、更新及刪除警報操作的指令。 警示是 Databricks SQL 物件,會定期執行查詢、評估其結果的條件,並在符合條件時通知一或多個使用者和/或通知目的地。 請參閱 Databricks SQL 警示。
Databricks 建立警示
建立警示。
databricks alerts create [flags]
選項
--auto-resolve-display-name
如果為 true,則會自動解決警示顯示名稱衝突。
--json JSON
內嵌 JSON 字串或 @path 指向 JSON 檔案的要求本文
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
下列範例會依識別碼刪除警示:
databricks alerts delete 12345
databricks 警報獲得
取得警示。
databricks alerts get ID [flags]
Arguments
ID
要取得之警示的標識碼。
選項
Examples
下列範例會依識別碼獲取警示:
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
要更新之警示的標識碼。
UPDATE_MASK
欄位遮罩必須是單一字串,並以逗號分隔多個字段(無空格)。 欄位路徑相對於資源物件,使用點號 (.) 巡覽子欄位 (例如 author.given_name)。 禁止指定序列或映射欄位中的元素,因為只能指定整個集合欄位。 功能變數名稱必須完全符合資源功能變數名稱。
星號 (*) 欄位掩碼表示完全替換。 建議一律明確列出要更新的字段,並避免使用通配符,因為如果 API 未來變更,可能會導致非預期的結果。
選項
--auto-resolve-display-name
如果為 true,則會自動解決警示顯示名稱衝突。
--json JSON
內嵌 JSON 字串或 @path 指向 JSON 檔案的要求本文
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、、appendinplace、 或json
-t, --target 字串
如果適用,要使用的套件組合目標