alerts 命令组

alerts Databricks CLI 中的命令组包含用于对警报执行获取、创建、更新和删除作的命令。 警报是 Databricks SQL 对象，它可定期运行查询，评估其结果的条件，并在满足条件时通知一个或多个用户和/或通知目标。 请参阅 Databricks SQL 警报。

创建 databricks 警报

创建警报。

databricks alerts create [flags]

选项

--auto-resolve-display-name

    如果为 true，则自动解决警报显示名称冲突。

--json JSON

    内联 JSON 字符串或包含请求正文的 JSON 文件

全局标志

例子

以下示例使用 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 警报删除

将警报移动到回收站。 已回收的警报会立即从搜索和列表视图中消失，并且无法再触发。 可以通过用户界面恢复已删除的警报。 30 天后将永久删除已回收的警报。

databricks alerts delete ID [flags]

论据

ID

    要删除的警报的 ID。

选项

全局标志

例子

以下示例按 ID 删除警报：

databricks alerts delete 12345

databricks 获取警报

获取警报。

databricks alerts get ID [flags]

论据

ID

    要获取的警报的 ID。

选项

全局标志

例子

以下示例按 ID 获取警报：

databricks alerts get 12345

databricks 警报列表

列出用户可访问的警报，按创建时间排序。

databricks alerts list [flags]

选项

--page-size int

    每页要返回的最大警报数。

--page-token string

    用于检索下一页结果的令牌。

全局标志

例子

以下示例列出所有警报：

databricks alerts list

以下示例展示了如何列出具有分页功能的警报：

databricks alerts list --page-size 10

databricks 警报更新

更新警报。

databricks alerts update ID UPDATE_MASK [flags]

论据

ID

    要更新的警报的 ID。

UPDATE_MASK

    字段掩码必须是单个字符串，多个字段用逗号分隔（无空格）。 字段路径是相对于资源对象而言的，通过点（.）来导航子字段（例如，author.given_name）。 不允许对序列或映射字段中的元素进行规范，因为只能指定整个集合字段。 字段名称必须与资源字段名称完全匹配。

    星号 （*） 字段掩码指示完全替换。 建议始终显式列出要更新的字段，避免使用通配符，因为如果 API 将来发生更改，可能会导致意外结果。

选项

--auto-resolve-display-name

    如果为 true，则自动解决警报显示名称冲突。

--json JSON

    内联 JSON 字符串或包含请求正文的 JSON 文件

全局标志

例子

以下示例使用 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 字符串

    如果适用，要使用的捆绑包目标