注释
此信息适用于 Databricks CLI 版本 0.205 及更高版本。 Databricks CLI 目前处于公共预览阶段。
Databricks CLI 的使用须遵守 Databricks 许可和 Databricks 隐私声明，包括任何数据使用规定。
Databricksalerts-v2 CLI 中的命令组允许管理 SQL 警报。 警报定期运行查询，评估其结果的条件，并在满足条件时通知一个或多个用户和/或通知目标。
databricks alerts-v2 create-alert
创建警报。
databricks alerts-v2 create-alert DISPLAY_NAME QUERY_TEXT WAREHOUSE_ID EVALUATION SCHEDULE [flags]
Arguments
DISPLAY_NAME
警报的显示名称。
QUERY_TEXT
要运行的查询的文本。
WAREHOUSE_ID
附加到警报的 SQL 仓库的 ID。
EVALUATION
警报的评估条件。
SCHEDULE
运行警报查询的计划。
选项
--custom-description string
警报的自定义说明。
--custom-summary string
警报的自定义摘要。
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
--parent-path string
包含警报的文件夹的工作区路径。
--run-as-user-name string
作为服务主体的用户名或应用程序 ID 运行。
示例
以下示例使用 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]
Arguments
ID
要检索的警报的 UUID。
选项
示例
以下示例按 ID 获取警报：
databricks alerts-v2 get-alert 12345678-1234-1234-1234-123456789012
databricks alerts-v2 list-alerts
列出警报。 获取用户可访问的警报列表，按创建时间排序。
databricks alerts-v2 list-alerts [flags]
Arguments
没有
选项
--page-size int
要返回的最大警报数。
--page-token string
上一个列表调用中的页面令牌，用于检索下一页。
示例
以下示例列出所有可访问的警报：
databricks alerts-v2 list-alerts
databricks alerts-v2 回收站警报
删除警报。 将警报移至回收站。 回收的警报会立即从列表视图中消失，并且无法再触发。 可以通过用户界面恢复已删除的警报。 已放入回收站的警报会在 30 天后永久删除。
databricks alerts-v2 trash-alert ID [flags]
Arguments
ID
警报的 UUID。
选项
--purge
是否永久删除警报。
示例
以下示例会回收警报：
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]
Arguments
ID
标识警报的 UUID。
UPDATE_MASK
用于指定要更新的字段的字段掩码。 使用逗号分隔的字段名称。 用于 * 更新所有字段。
DISPLAY_NAME
警报的显示名称。
QUERY_TEXT
要运行的查询的文本。
WAREHOUSE_ID
附加到警报的 SQL 仓库的 ID。
EVALUATION
警报的评估条件。
SCHEDULE
运行警报查询的计划。
选项
--custom-description string
警报的自定义说明。
--custom-summary string
警报的自定义摘要。
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
--parent-path string
包含警报的文件夹的工作区路径。
--run-as-user-name string
作为服务主体的用户名或应用程序 ID 运行。
示例
以下示例更新警报的显示名称：
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 格式
日志格式类型，text 或 json。 默认值为 text。
--log-level 字符串
一个表示日志格式级别的字符串。 如果未指定，则禁用日志格式级别。
-o, --output 类型
命令输出类型为 text 或 json。 默认值为 text。
-p, --profile 字符串
要用于运行命令的 ~/.databrickscfg 文件中的配置文件名称。 如果未指定此标志，并且存在命名为 DEFAULT 的配置文件，则使用该配置文件。
--progress-format 格式
显示进度日志的格式： default、 append、 inplace或 json
-t, --target 字符串
如果适用，要使用的捆绑包目标