Aller au contenu principal

groupe de commandesalerts

remarque

L'utilisation de Databricks CLI est soumise à la licence Databricks et à la politique de confidentialité Databricks, y compris toutes les dispositions relatives aux données d'utilisation.

Le groupe de commandes alerts au sein de la CLI Databricks contient des commandes pour effectuer des opérations de récupération, création, mise à jour et suppression sur les alertes. Une alerte est un objet Databricks SQL qui exécute périodiquement une query, évalue une condition de son résultat et notifie un ou plusieurs utilisateurs et/ou destinations de notification si la condition est remplie. Consultez les alertes Databricks SQL.

databricks alerts create

Créer une alerte.

databricks alerts create [flags]

Options

--auto-resolve-display-name

Si vrai, résoudre automatiquement les conflits de nom d'affichage d'alerte.

--json JSON

La chaîne JSON en ligne ou le @path vers le fichier JSON avec le corps de la requête

Indicateurs globaux

Exemples

L'exemple suivant crée une alerte à l'aide de JSON :

Bash
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}'

L'exemple suivant crée une alerte à l'aide d'un fichier JSON :

Bash
databricks alerts create --json @alert.json

supprimer les alertes Databricks

Déplace une alerte vers la corbeille. Les alertes mises à la corbeille disparaissent immédiatement des recherches et des vues de liste, et ne peuvent plus Trigger. Vous pouvez restaurer une alerte mise à la corbeille via l'interface utilisateur. Une alerte mise à la corbeille est supprimée définitivement après 30 jours.

databricks alerts delete ID [flags]

Arguments

ID

L'ID de l'alerte à supprimer.

Options

Indicateurs globaux

Exemples

L'exemple suivant supprime une alerte par ID :

Bash
databricks alerts delete 12345

récupérer les alertes Databricks

Recevez une alerte.

databricks alerts get ID [flags]

Arguments

ID

ID de l’alerte à récupérer.

Options

Indicateurs globaux

Exemples

L'exemple suivant récupère une alerte par ID :

Bash
databricks alerts get 12345

Liste des alertes Databricks

Lister les alertes accessibles à l'utilisateur, classées par heure de création.

important

L'exécution de cette commande plus de 10 fois simultanément pourrait entraîner une limitation, une dégradation du service ou une interdiction temporaire.

databricks alerts list [flags]

Options

--page-size int

Nombre maximal d'alertes à renvoyer par page.

--page-token string

Jeton pour récupérer la page suivante de résultats.

Indicateurs globaux

Exemples

L'exemple suivant liste toutes les alertes :

Bash
databricks alerts list

L’exemple suivant répertorie les alertes avec pagination :

Bash
databricks alerts list --page-size 10

Databricks alerts update

Mettre à jour une alerte.

databricks alerts update ID UPDATE_MASK [flags]

Arguments

ID

L'ID de l'alerte à mettre à jour.

UPDATE_MASK

Le masque de champ doit être une chaîne unique, avec plusieurs champs séparés par des virgules (sans espaces). Le chemin de champ est relatif à l’objet ressource, en utilisant un point (.) pour naviguer dans les sous-champs (par exemple, author.given_name). La spécification d’éléments dans des champs de séquence ou de carte n’est pas autorisée, car seul le champ de collection entier peut être spécifié. Les noms de champs doivent correspondre exactement aux noms des champs de ressource.

Un masque de champ astérisque (*) indique un remplacement complet. Il est recommandé de toujours lister explicitement les champs mis à jour et d'éviter l'utilisation de caractères génériques, car cela peut entraîner des résultats inattendus si l'API change à l'avenir.

Options

--auto-resolve-display-name

Si vrai, résoudre automatiquement les conflits de nom d'affichage d'alerte.

--json JSON

La chaîne JSON en ligne ou le @path vers le fichier JSON avec le corps de la requête

Indicateurs globaux

Exemples

L'exemple suivant met à jour une alerte à l'aide de JSON :

Bash
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}'

L'exemple suivant met à jour une alerte à l'aide d'un fichier JSON :

Bash
databricks alerts update 12345 "name,condition" --json @update-alert.json

Drapeaux globaux

--debug

Activer ou non la journalisation de débogage.

-h OU --help

Afficher l'aide de Databricks CLI ou du groupe de commandes associé ou de la commande associée.

--log-file chaîne

Une chaîne représentant le fichier dans lequel écrire les logs de sortie. Si cet indicateur n'est pas spécifié, la default est d'écrire les logs de sortie dans stderr.

--log-format Format

Le type de format de log, text ou json. La valeur par default est text.

--log-level chaîne

Une chaîne représentant le niveau de format du log. S'il n'est pas spécifié, le niveau de format du log est désactivé.

-o, --output Type

Le type de sortie de commande, text ou json. La valeur par default est text.

-p, --profile chaîne

Nom du profil dans le fichier ~/.databrickscfg à utiliser pour exécuter la commande. Si cet indicateur n'est pas spécifié, alors s'il existe, le profil nommé DEFAULT est utilisé.

--progress-format Format

Le format pour afficher les logs de progression : default, append, inplace ou json

-t, --target chaîne

Le cas échéant, la cible de bundle à utiliser