Grupo de comandos api

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 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, consulte os comandos da CLI do Databricks.

exclusão de API do Databricks

Executar solicitação DELETE

databricks api delete PATH [flags]

Arguments

PATH

    O caminho do ponto de extremidade de API

Opções

--json JSON

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

Sinalizadores globais

Examples

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

obtenção do GET da API do Databricks

Executar GET solicitação

databricks api get PATH [flags]

Arguments

PATH

    O caminho do ponto de extremidade de API

Opções

--json JSON

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

Sinalizadores globais

Examples

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

databricks api get /api/2.0/clusters/list

O exemplo a seguir obtém um trabalho:

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

cabeçalho da API do Databricks

Executar a solicitação HEAD

databricks api head PATH [flags]

Arguments

PATH

    O caminho do ponto de extremidade de API

Opções

--json JSON

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

Sinalizadores globais

Examples

databricks api head /api/2.0/clusters/list

patch de API Databricks

Executar a solicitação PATCH

databricks api patch PATH [flags]

Arguments

PATH

    O caminho do ponto de extremidade de API

Opções

--json JSON

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

Sinalizadores globais

Examples

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

Databricks API POST

Executar solicitação POST

databricks api post PATH [flags]

Arguments

PATH

    O caminho do ponto de extremidade de API

Opções

--json JSON

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

Sinalizadores globais

Examples

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

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

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

databricks API put

Executar solicitação PUT

databricks api put PATH [flags]

Arguments

PATH

    O caminho do ponto de extremidade de API

Opções

--json JSON

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

Sinalizadores globais

Examples

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

Sinalizadores globais

--debug

  Indica se deve habilitar o registro em log de depuração.

-h ou --help

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

--log-file corda

    Uma cadeia de caracteres que representa o arquivo para o qual gravar logs de saída. Se esse sinalizador não for especificado, o padrão será gravar logs de saída no stderr.

--log-format formato

    O tipo de formato de log, text ou json. O valor padrão é text.

--log-level corda

    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á desabilitado.

-o, --output tipo

    O tipo de saída de comando, text ou json. O valor padrão é text.

-p, --profile corda

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

--progress-format formato

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

-t, --target corda

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