api groupe de commande

Note

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 api groupe de commandes dans 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, consultez les commandes CLI Databricks.

databricks API supprimer

Effectuer une demande DELETE

databricks api delete PATH [flags]

Arguments

PATH

    Chemin du point de terminaison de l’API

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête

Indicateurs globaux

Examples

databricks api delete /api/2.0/jobs/runs/delete --json '{"run_id": 123}'

récupérer l'API de Databricks

Effectuer une GET demande

databricks api get PATH [flags]

Arguments

PATH

    Chemin du point de terminaison de l’API

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête

Indicateurs globaux

Examples

L’exemple suivant obtient la liste des clusters disponibles dans l’espace de travail :

databricks api get /api/2.0/clusters/list

L’exemple suivant obtient un travail :

databricks api get /api/2.0/jobs/get --json '{"job_id": 123}'

databricks api head

Effectuer une requête HEAD

databricks api head PATH [flags]

Arguments

PATH

    Chemin du point de terminaison de l’API

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête

Indicateurs globaux

Examples

databricks api head /api/2.0/clusters/list

correctif d’API databricks

Effectuer une requête PATCH

databricks api patch PATH [flags]

Arguments

PATH

    Chemin du point de terminaison de l’API

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête

Indicateurs globaux

Examples

databricks api patch /api/2.0/jobs/update --json '{"job_id": 123, "new_settings": {"name": "Updated Job"}}'

publication de l’API databricks

Effectuer une requête POST

databricks api post PATH [flags]

Arguments

PATH

    Chemin du point de terminaison de l’API

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête

Indicateurs globaux

Examples

L’exemple suivant obtient 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"
}'

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

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"
}

Opération PUT de l'API Databricks

Effectuer une requête PUT

databricks api put PATH [flags]

Arguments

PATH

    Chemin du point de terminaison de l’API

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête

Indicateurs globaux

Examples

databricks api put /api/2.0/workspace/import --json @workspace-import.json

Indicateurs globaux

--debug

  Active la journalisation du débogage.

-h ou --help

    Affiche l’aide pour l’interface CLI de Databricks, le groupe de commandes associé ou la commande concernée.

--log-file chaîne de caractères

    Chaîne représentant le fichier dans lequel écrire les journaux de sortie. Si cet indicateur n’est pas défini, les journaux de sortie sont écrits par défaut dans stderr.

--log-format format

    Format des journaux : text ou json. La valeur par défaut est text.

--log-level chaîne de caractères

    Chaîne représentant le niveau de journalisation. Si cet indicateur n’est pas défini, le niveau de format de journal est désactivé.

Type -o, --output

    Type de sortie de commande, text ou json. La valeur par défaut est text.

-p, --profile chaîne de caractères

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

--progress-format format

    Format permettant d’afficher les journaux de progression : default, append, inplace ou json

-t, --target chaîne de caractères

    Le cas échéant, la cible d’offre groupée à utiliser