Partilhar via

api grupo de comando

  • Artigo

Nota

Essas informações se aplicam às versões 0.205 e superiores da CLI do Databricks. A CLI do Databricks está em Visualização Pública.

O uso da CLI do Databricks está sujeito à Licença do Databricks e ao Aviso de Privacidade do Databricks, incluindo quaisquer disposições de Dados de Uso.

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

Você deve executar o api comando somente para cenários avançados, como versões de visualização de APIs REST específicas do Databricks 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 Comandos da CLI do Databricks.

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

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

Execute api comandos anexando-os ao databricks api. Para exibir a ajuda para o api comando, execute databricks api -h.

Para chamar o api comando, use o seguinte formato:

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

No convite anterior:

  • Substitua <http-method> pelo método HTTP para a API REST do Databricks que você deseja chamar, como delete, get, , pathhead, post, ou put. Por exemplo, para retornar a lista de clusters disponíveis para um espaço de trabalho, 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 espaço de trabalho. Por exemplo, para retornar a lista de clusters disponíveis para um espaço de trabalho, 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 de 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

Obtenha a lista de clusters disponíveis no espaço de trabalho.

databricks api get /api/2.0/clusters/list

Obtenha informações sobre o cluster especificado no espaço de trabalho.

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

Atualize as configurações para o cluster especificado no espaço de trabalho.

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

Atualize as configurações para o cluster especificado no espaço de trabalho. Obtenha o corpo da solicitação de um arquivo nomeado edit-cluster.json dentro do 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"
}