api gruppo di comandi

Il api gruppo di comandi all'interno dell'interfaccia della riga di comando di Databricks consente di chiamare qualsiasi API REST di Databricks disponibile.

È consigliabile eseguire il api comando solo per scenari avanzati, ad esempio le versioni di anteprima di SPECIFICHE API REST di Databricks per cui l'interfaccia della riga di comando di Databricks non esegue già il wrapping dell'API REST di Databricks di destinazione all'interno di un comando correlato. Per un elenco dei gruppi di comandi di cui è stato eseguito il wrapping, vedere Comandi dell'interfaccia della riga di comando di Databricks.

Per installare Databricks CLI non è installato, consultare Installare o aggiornare il Databricks CLI. Per configurare l'autenticazione il Databricks CLI, consultare Autenticazione per il Databricks CLI.

Eseguire api i comandi (solo per scenari avanzati)

I comandi api vengono eseguiti aggiungendoli a databricks api. Per visualizzare il supporto per il comando api, esegui databricks api -h.

Per chiamare il api comando, usare il formato seguente:

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

Nella chiamata precedente:

• Sostituire <http-method> con il metodo HTTP per l'API REST di Databricks che si vuole chiamare, ad esempio delete, headgetpath, , posto .put Ad esempio, per restituire l'elenco dei cluster disponibili per un'area di lavoro, usare get. Per ottenere il metodo HTTP corretto per l'API REST di Databricks che si vuole chiamare, vedere la documentazione dell'API REST di Databricks.
• Sostituire <rest-api-path> con il percorso dell'API REST di Databricks che si vuole chiamare. Non includere https:// o il nome dell'istanza dell'area di lavoro. Ad esempio, per restituire l'elenco dei cluster disponibili per un'area di lavoro, usare /api/2.0/clusters/list. Per ottenere la sintassi corretta per l'API REST di Databricks che si vuole chiamare, vedere la documentazione dell'API REST di Databricks.
• Se l'API REST di Databricks che si vuole chiamare richiede un corpo della richiesta, includere --json e <request-body>, sostituendo <request-body> con il corpo della richiesta in formato JSON. In alternativa, è possibile archiviare il corpo della richiesta in un file JSON separato. A tale scopo, includere --json e @<filename>, sostituendo <filename> con il nome del file JSON. Per ottenere la sintassi corretta per il corpo della richiesta da includere, vedere la documentazione dell'API REST di Databricks.

Esempi

Ottenere l'elenco dei cluster disponibili nell'area di lavoro.

databricks api get /api/2.0/clusters/list

Ottenere informazioni sul cluster specificato nell'area di lavoro.

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

Aggiornare le impostazioni per il cluster specificato nell'area di lavoro.

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

Aggiornare le impostazioni per il cluster specificato nell'area di lavoro. Ottenere il corpo della richiesta da un file denominato edit-cluster.json all'interno della directory di lavoro corrente.

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