Grupo de comandos api

Observação

Essas informações se aplicam às versões da CLI do Databricks 0.205 e superiores, que estão em Versão Prévia Pública. Para localizar sua versão da CLI do Databricks, execute databricks -v.

O grupo de comandos api na CLI do Databricks permite que você chame qualquer API REST do Databricks disponível.

Você deve executar o comando api apenas para cenários avançados, como versões prévias de APIs REST do Databricks específicas para as quais a CLI do Databricks ainda não encapsula a API REST do Databricks de destino em um comando relacionado. Para obter uma lista de grupos de comandos encapsulados, consulte os comandos da CLI do Databricks.

Importante

Para instalar a CLI do Databricks, consulte Instalar ou atualizar a CLI do Databricks. Para configurar a autenticação na CLI do Databricks, consulte Autenticação na CLI do Databricks.

Executar api comandos (somente para cenários avançados)

Você executa api comando acrescentando-os a databricks api. Para exibir a ajuda para o comando api, execute databricks api -h.

Para chamar o comando api, use o seguinte formato:

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

Na chamada anterior:

• Substitua <http-method> pelo método HTTP para a API REST do Databricks que você deseja chamar, como delete, get, head, path, post ou put. Por exemplo, para retornar a lista de clusters disponíveis para um workspace, use get. Para obter o método HTTP correto para a API REST do Databricks que você deseja chamar, consulte a documentação da API REST do Databricks.
• Substitua <rest-api-path> pelo caminho para a API REST do Databricks que você deseja chamar. Não inclua https:// nem o nome da instância do workspace. Por exemplo, para retornar a lista de clusters disponíveis para um workspace, use /api/2.0/clusters/list. Para obter a sintaxe correta para a API REST do Databricks que você deseja chamar, consulte a documentação da API REST do Databricks.
• Se a API REST do Databricks que você deseja chamar exigir um corpo da solicitação, inclua --json e <request-body>, substituindo <request-body> pelo corpo da solicitação no formato JSON. Como alternativa, você pode armazenar o corpo da solicitação em um arquivo JSON separado. Para fazer isso, inclua --json e @<filename>, substituindo <filename> pelo nome do arquivo JSON. Para obter a sintaxe correta para o corpo da solicitação que você deseja incluir, consulte a documentação da API REST do Databricks.

Exemplos

Obter a lista de clusters disponíveis no workspace.

databricks api get /api/2.0/clusters/list

Obter informações sobre o cluster especificado no workspace.

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

Atualizar as configurações do cluster especificado no 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": "Standard_DS3_v2"
}'

Atualizar as configurações do cluster especificado no workspace. Obter o corpo da solicitação de um arquivo chamado edit-cluster.json no diretório de trabalho atual.

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