api grupo de comando

nota

Esta informação se aplica a Databricks CLI versões 0.205 e acima. A CLI do Databricks está em pré-visualização pública.

Databricks CLI O uso está sujeito à LicençaDatabricks e à Política de PrivacidadeDatabricks, incluindo qualquer disposição sobre Dados de Uso.

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

Recomenda-se executar o comando “ api ” apenas em cenários avançados, como versões prévias de Databricks REST APIs para os quais o comando “ Databricks ” CLI ainda não envolve o destino “ Databricks ” REST API dentro de um comando relacionado. Para obter uma lista de grupos de comando, consulte Databricks CLI comando.

exclusão da API databricks

Executar solicitação DELETE

databricks api delete PATH [flags]

Argumentos

PATH

O caminho API endpoint

Opções

--json JSON

As strings JSON em linha ou o @path para o arquivo JSON com o corpo da solicitação

Bandeiras globais

Exemplos

Bash

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

api databricks get

Executar solicitação GET

databricks api get PATH [flags]

Argumentos

PATH

O caminho API endpoint

Opções

--json JSON

As strings JSON em linha ou o @path para o arquivo JSON com o corpo da solicitação

Bandeiras globais

Exemplos

O exemplo a seguir obtém a lista de agrupamentos disponíveis no workspace:

Bash

databricks api get /api/2.0/clusters/list

O exemplo a seguir obtém um trabalho:

Bash

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

cabeça de API Databricks

Executar solicitação HEAD

databricks api head PATH [flags]

Argumentos

PATH

O caminho API endpoint

Opções

--json JSON

As strings JSON em linha ou o @path para o arquivo JSON com o corpo da solicitação

Bandeiras globais

Exemplos

Bash

databricks api head /api/2.0/clusters/list

patch de API Databricks

Executar solicitação PATCH

databricks api patch PATH [flags]

Argumentos

PATH

O caminho API endpoint

Opções

--json JSON

As strings JSON em linha ou o @path para o arquivo JSON com o corpo da solicitação

Bandeiras globais

Exemplos

Bash

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

publicação da API databricks

Executar solicitação POST

databricks api post PATH [flags]

Argumentos

PATH

O caminho API endpoint

Opções

--json JSON

As strings JSON em linha ou o @path para o arquivo JSON com o corpo da solicitação

Bandeiras globais

Exemplos

O exemplo a seguir obtém informações sobre o agrupamento especificado em workspace.

Bash

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

O exemplo a seguir cria um agrupamento:

Bash

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 agrupamento especificado em “ workspace” (Configurações de cluster > Grupo de servidores de controle de cluster).

Bash

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": "n2-highmem-4"
}'

Atualize as configurações para o agrupamento especificado em “ workspace”. Obtenha o corpo da solicitação de um arquivo chamado edit-cluster.json no diretório de trabalho atual.

Bash

databricks api post /api/2.0/clusters/edit --json @edit-cluster.json

edit-cluster.json:

JSON

{
  "cluster_id": "1234-567890-abcde123",
  "cluster_name": "my-changed-cluster",
  "num_workers": 1,
  "spark_version": "11.3.x-scala2.12",
  "node_type_id": "n2-highmem-4"
}

API databricks put

Executar solicitação PUT

databricks api put PATH [flags]

Argumentos

PATH

O caminho API endpoint

Opções

--json JSON

As strings JSON em linha ou o @path para o arquivo JSON com o corpo da solicitação

Bandeiras globais

Exemplos

Bash

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

Bandeiras globais

--debug

Se deve habilitar o registro de depuração.

-h ou --help

Exibir ajuda para o comando Databricks CLI ou para o grupo de comandos relacionado ou para o comando relacionado.

--log-file string

Uma string que representa o arquivo no qual a saída logs deve ser gravada. Se este sinalizador não for especificado, o default deverá gravar a saída logs no stderr.

--log-format Formato

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

--log-level string

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

-o, --output Tipo

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

-p, --profile string

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

--progress-format Formato

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

-t, --target string

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