Partilhar via


api grupo de comando

Note

Essas informações se aplicam às versões 0.205 e superiores da CLI do Databricks. A CLI do Databricks está em Pré-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 Databricks permite-lhe chamar qualquer API REST 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, consulte Comandos da CLI do Databricks.

Exclusão da API Databricks

Executar solicitação DELETE

databricks api delete PATH [flags]

Arguments

PATH

    O caminho do ponto de extremidade da API

Opções

--json JSON

    A cadeia de caracteres JSON embutida ou o @path para o arquivo JSON com o corpo da solicitação

Bandeiras globais

Examples

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

Databricks API Obter

Executar GET solicitação

databricks api get PATH [flags]

Arguments

PATH

    O caminho do ponto de extremidade da API

Opções

--json JSON

    A cadeia de caracteres JSON embutida ou o @path para o arquivo JSON com o corpo da solicitação

Bandeiras globais

Examples

O exemplo a seguir obtém a lista de clusters disponíveis no espaço de trabalho:

databricks api get /api/2.0/clusters/list

O exemplo a seguir consegue um emprego:

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

Cabeça da API Databricks

Executar solicitação HEAD

databricks api head PATH [flags]

Arguments

PATH

    O caminho do ponto de extremidade da API

Opções

--json JSON

    A cadeia de caracteres JSON embutida ou o @path para o arquivo JSON com o corpo da solicitação

Bandeiras globais

Examples

databricks api head /api/2.0/clusters/list

Patch da API Databricks

Executar solicitação de PATCH

databricks api patch PATH [flags]

Arguments

PATH

    O caminho do ponto de extremidade da API

Opções

--json JSON

    A cadeia de caracteres JSON embutida ou o @path para o arquivo JSON com o corpo da solicitação

Bandeiras globais

Examples

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

Postagem da API Databricks

Executar solicitação POST

databricks api post PATH [flags]

Arguments

PATH

    O caminho do ponto de extremidade da API

Opções

--json JSON

    A cadeia de caracteres JSON embutida ou o @path para o arquivo JSON com o corpo da solicitação

Bandeiras globais

Examples

O exemplo a seguir obtém 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"
}'

O exemplo a seguir cria um cluster:

databricks api post /api/2.0/clusters/create --json '{"cluster_name": "test-cluster", "spark_version": "11.3.x-scala2.12"}'

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

Operação Put na API Databricks

Executar solicitação PUT

databricks api put PATH [flags]

Arguments

PATH

    O caminho do ponto de extremidade da API

Opções

--json JSON

    A cadeia de caracteres JSON embutida ou o @path para o arquivo JSON com o corpo da solicitação

Bandeiras globais

Examples

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

Bandeiras globais

--debug

  Se o log de depuração deve ser habilitado.

-h ou --help

    Exiba a ajuda para a CLI do Databricks ou para o grupo de comandos relacionado ou para o comando relacionado.

--log-file string

    Uma cadeia de caracteres que representa o ficheiro onde os registos de saída são gravados. Se esse sinalizador não for especificado, o padrão é gravar logs de saída no stderr.

--log-format Formato

    O tipo de formato de log, text ou json. O valor predefinido é text.

--log-level string

    Uma cadeia de caracteres que representa o nível de formato de log. Se não for especificado, o nível de formato de log será desativado.

-o, --output tipo

    O tipo de saída do comando, text ou json. O valor predefinido é text.

-p, --profile string

    O nome do perfil no arquivo ~/.databrickscfg a ser usado para executar o comando. Se esse sinalizador não for especificado, se ele existir, o perfil nomeado DEFAULT será usado.

--progress-format Formato

    O formato para exibir logs de progresso: default, append, inplace, ou json

-t, --target string

    Se aplicável, o destino do pacote a ser usado