groupe de commandesapi
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 api au sein de la Databricks CLI vous permet d'appeler n'importe quelle Databricks REST API disponible.
Vous ne devez exécuter la commande api que pour des scénarios avancés, tels que les versions préliminaires d’APIs REST Databricks spécifiques pour lesquelles la CLI Databricks n’encapsule pas déjà l’API REST Databricks cible dans une commande associée. Pour obtenir la liste des groupes de commandes, consultez les commandes CLI de Databricks.
suppression de l'API Databricks
Effectuer une requête DELETE
databricks api delete PATH [flags]
Arguments
PATH
Le chemin d'accès au endpoint de l'API
Options
--json JSON
La chaîne JSON en ligne ou le @path vers le fichier JSON avec le corps de la requête
Exemples
databricks api delete /api/2.0/jobs/runs/delete --json '{"run_id": 123}'
obtention de l'API Databricks
Effectuer une requête GET
databricks api get PATH [flags]
Arguments
PATH
Le chemin d'accès au endpoint de l'API
Options
--json JSON
La chaîne JSON en ligne ou le @path vers le fichier JSON avec le corps de la requête
Exemples
L'exemple suivant obtient la liste des clusters disponibles dans le Workspace :
databricks api get /api/2.0/clusters/list
L'exemple suivant obtient un job :
databricks api get /api/2.0/jobs/get --json '{"job_id": 123}'
Databricks API en-tête
Exécuter la requête HEAD
databricks api head PATH [flags]
Arguments
PATH
Le chemin d'accès au endpoint de l'API
Options
--json JSON
La chaîne JSON en ligne ou le @path vers le fichier JSON avec le corps de la requête
Exemples
databricks api head /api/2.0/clusters/list
patch d'API Databricks
Effectuer une requête PATCH
databricks api patch PATH [flags]
Arguments
PATH
Le chemin d'accès au endpoint de l'API
Options
--json JSON
La chaîne JSON en ligne ou le @path vers le fichier JSON avec le corps de la requête
Exemples
databricks api patch /api/2.0/jobs/update --json '{"job_id": 123, "new_settings": {"name": "Updated Job"}}'
databricks api post
Exécuter une requête POST
databricks api post PATH [flags]
Arguments
PATH
Le chemin d'accès au endpoint de l'API
Options
--json JSON
La chaîne JSON en ligne ou le @path vers le fichier JSON avec le corps de la requête
Exemples
L'exemple suivant obtient des informations sur le cluster spécifié dans le Workspace.
databricks api post /api/2.0/clusters/get --json '{
"cluster_id": "1234-567890-abcde123"
}'
L'exemple suivant crée un cluster :
databricks api post /api/2.0/clusters/create --json '{"cluster_name": "test-cluster", "spark_version": "11.3.x-scala2.12"}'
Mettre à jour les paramètres du cluster spécifié dans le workspace.
databricks api post /api/2.0/clusters/edit --json '{
"cluster_id": "1234-567890-abcde123",
"cluster_name": "my-changed-cluster",
"num_workers": 1,
"spark_version": "11.3.x-scala2.12",
"node_type_id": "i3.xlarge"
}'
Mettre à jour les paramètres pour le cluster spécifié dans le Workspace. Récupérez le corps de la requête à partir d'un fichier nommé edit-cluster.json dans le répertoire de travail actuel.
databricks api post /api/2.0/clusters/edit --json @edit-cluster.json
edit-cluster.json:
{
"cluster_id": "1234-567890-abcde123",
"cluster_name": "my-changed-cluster",
"num_workers": 1,
"spark_version": "11.3.x-scala2.12",
"node_type_id": "i3.xlarge"
}
databricks API put
Effectuer une requête PUT.
databricks api put PATH [flags]
Arguments
PATH
Le chemin d'accès au endpoint de l'API
Options
--json JSON
La chaîne JSON en ligne ou le @path vers le fichier JSON avec le corps de la requête
Exemples
databricks api put /api/2.0/workspace/import --json @workspace-import.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