Partager via

api groupe de commande

  • Article

Remarque

Ces informations s’appliquent à Databricks CLI versions 0.205 et ultérieures. L’interface CLI Databricks est en préversion publique.

L’utilisation de l’interface CLI Databricks est soumise à la licence Databricks et à la notification de confidentialité Databricks, y compris les dispositions relatives aux données d’utilisation.

Le groupe de commandes api de l’interface CLI Databricks vous permet d’appeler n’importe quelle API REST Databricks disponible.

Vous devez exécuter la commande api uniquement pour les scénarios avancés, par exemple les préversions d’API REST Databricks spécifiques, pour lesquelles l’interface CLI Databricks ne wrappe pas encore l’API REST Databricks cible dans une commande associée. Pour obtenir la liste des groupes de commandes encapsulés, consultez Commandes CLI Databricks.

Pour installer l’interface CLI Databricks, consultez Installer ou mettre à jour l’interface CLI Databricks. Pour configurer l’authentification pour l’interface CLI Databricks, consultez Authentification pour CLI Databricks.

Exécuter des commandes api (pour les scénarios avancés uniquement)

Vous exécutez les commandes api en les ajoutant à databricks api. Pour afficher l’aide sur la commande api, exécutez databricks api -h.

Pour appeler la commande api, utilisez le format suivant :

databricks api <http-method> <rest-api-path> [--json {<request-body> | @<filename>}]

Dans l’appel précédent :

  • Remplacez <http-method> par la méthode HTTP de l’API REST Databricks à appeler, par exemple delete, get, head, path, post ou put. Par exemple, pour retourner la liste des clusters disponibles pour un espace de travail, utilisez get. Pour obtenir la méthode HTTP appropriée correspondant à l’API REST Databricks à appeler, consultez la documentation de l’API REST Databricks.
  • Remplacez <rest-api-path> par le chemin de l’API REST Databricks à appeler. N’incluez pas https:// ou le nom de l’instance d’espace de travail. Par exemple, pour retourner la liste des clusters disponibles pour un espace de travail, utilisez /api/2.0/clusters/list. Pour obtenir la syntaxe appropriée correspondant à l’API REST Databricks à appeler, consultez la documentation de l’API REST Databricks.
  • Si l’API REST Databricks à appeler nécessite un corps de requête, incluez --json et <request-body>, en remplaçant <request-body> par le corps de requête au format JSON. Vous pouvez également stocker le corps de la requête dans un fichier JSON distinct. Pour ce faire, incluez --json et @<filename>, en remplaçant <filename> par le nom du fichier JSON. Pour obtenir la syntaxe appropriée correspondant au corps de requête à inclure, consultez la documentation de l’API REST Databricks.

Exemples

Permet d’obtenir la liste des clusters disponibles dans l’espace de travail.

databricks api get /api/2.0/clusters/list

Permet d’obtenir des informations sur le cluster spécifié dans l’espace de travail.

databricks api post /api/2.0/clusters/get --json '{
   "cluster_id": "1234-567890-abcde123"
}'

Permet de mettre à jour les paramètres du cluster spécifié dans l’espace de travail.

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": "Standard_DS3_v2"
}'

Permet de mettre à jour les paramètres du cluster spécifié dans l’espace de travail. Permet d’obtenir 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": "Standard_DS3_v2"
}