alerts-v2 группа команд

Note

Эта информация относится к Интерфейсу командной строки Databricks версии 0.205 и выше. Интерфейс командной строки Databricks находится в общедоступной предварительной версии.

Использование интерфейса командной строки Databricks подчиняется лицензии Databricks и уведомлению о конфиденциальности Databricks, включая любые положения о данных использования.

Группа alerts-v2 команд в интерфейсе командной строки Databricks позволяет управлять оповещениями 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, присоединенного к оповещению.

EVALUATION

    Условие оценки оповещения.

SCHEDULE

    Расписание выполнения запроса генерации оповещений.

Options

--custom-description string

    Настраиваемое описание оповещения.

--custom-summary string

    Настраиваемая сводка для оповещения.

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

--parent-path string

    Путь к рабочей области папки, содержащей оповещение.

--run-as-user-name string

    Имя пользователя или идентификатор приложения субъекта-службы.

Глобальные флаги

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 оповещения, который требуется извлечь.

Options

Глобальные флаги

Examples

Следующий пример получает оповещение по идентификатору:

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

databricks alerts-v2 list-alerts

Вывод списка оповещений. Получает список оповещений, доступных пользователю, упорядоченным по времени создания.

databricks alerts-v2 list-alerts [flags]

Аргументы

Нет

Options

--page-size int

    Максимальное количество возвращаемых оповещений.

--page-token string

    Маркер страницы из предыдущего вызова списка для получения следующей страницы.

Глобальные флаги

Examples

В следующем примере перечислены все доступные оповещения:

databricks alerts-v2 list-alerts

databricks alerts-v2 корзина оповещение

Удаление оповещения. Перемещает оповещение в корзину. Корзина оповещений сразу же исчезает из представлений списка и больше не может активироваться. Вы можете восстановить удалённое оповещение через интерфейс пользователя. Удалённое оповещение перманентно удаляется через 30 дней.

databricks alerts-v2 trash-alert ID [flags]

Аргументы

ID

    Идентификатор UUID оповещения для корзины.

Options

--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, присоединенного к оповещению.

EVALUATION

    Условие оценки оповещения.

SCHEDULE

    Расписание выполнения запроса генерации оповещений.

Options

--custom-description string

    Настраиваемое описание оповещения.

--custom-summary string

    Настраиваемая сводка для оповещения.

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

--parent-path string

    Путь к рабочей области папки, содержащей оповещение.

--run-as-user-name string

    Имя пользователя или идентификатор приложения субъекта-службы.

Глобальные флаги

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, связанной группе команд или отдельной команде.

--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 струна

    Если применимо, целевой объект пакета для использования