api группа команд

The api command group within the Databricks CLI enables you to call any available Databricks REST API.

Вы должны выполнить api команду только для расширенных сценариев, таких как предварительные выпуски определенных REST API Databricks, для которых интерфейс командной строки Databricks еще не упаковывает целевой REST API Databricks в связанную команду. Список групп команд см. в разделе "Команды CLI Databricks".

удаление API databricks

Выполнение запроса DELETE

databricks api delete PATH [flags]

Arguments

PATH

    Путь конечной точки API

Options

--json JSON

    Встроенная строка JSON или @path JSON-файл с текстом запроса

Global flags

Examples

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

получение API databricks

Выполнение GET запроса

databricks api get PATH [flags]

Arguments

PATH

    Путь конечной точки API

Options

--json JSON

    Встроенная строка JSON или @path JSON-файл с текстом запроса

Global flags

Examples

В следующем примере показано, как получить список доступных кластеров в рабочей области:

databricks api get /api/2.0/clusters/list

Следующий пример получает задание:

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

Головка API databricks

Выполнение запроса HEAD

databricks api head PATH [flags]

Arguments

PATH

    Путь конечной точки API

Options

--json JSON

    Встроенная строка JSON или @path JSON-файл с текстом запроса

Global flags

Examples

databricks api head /api/2.0/clusters/list

Исправление API databricks

Выполнение запроса PATCH

databricks api patch PATH [flags]

Arguments

PATH

    Путь конечной точки API

Options

--json JSON

    Встроенная строка JSON или @path JSON-файл с текстом запроса

Global flags

Examples

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

Post api databricks

Выполнение запроса POST

databricks api post PATH [flags]

Arguments

PATH

    Путь конечной точки API

Options

--json JSON

    Встроенная строка JSON или @path JSON-файл с текстом запроса

Global flags

Examples

В следующем примере показано, как получить сведения о указанном кластере в рабочей области.

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

В следующем примере создается кластер:

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

Обновление параметров для указанного кластера в рабочей области.

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

Обновление параметров для указанного кластера в рабочей области. Получите текст запроса из файла с именем edit-cluster.json в текущем рабочем каталоге.

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

API databricks put

Выполнение запроса PUT

databricks api put PATH [flags]

Arguments

PATH

    Путь конечной точки API

Options

--json JSON

    Встроенная строка JSON или @path JSON-файл с текстом запроса

Global flags

Examples

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

Global flags

--debug

  Следует ли включить ведение журнала отладки.

-h или --help

    Отобразить справку по интерфейсу командной строки Databricks, связанной группе команд или отдельной команде.

--log-file струна

    Строка, представляющая файл для записи журналов выходных данных. Если этот флаг не указан, по умолчанию используется запись журналов выходных данных в stderr.

--log-format формат

    Тип text формата журнала или json. Значение по умолчанию — text.

--log-level струна

    Строка, представляющая уровень формата журнала. Если не указано, уровень формата журнала отключен.

типа -o, --output

    Тип text выходных данных команды или json. Значение по умолчанию — text.

-p, --profile струна

    Имя профиля в ~/.databrickscfg файле, используемого для выполнения команды. Если этот флаг не указан, то если он существует, используется DEFAULT профиль.

--progress-format формат

    Формат для отображения журналов хода выполнения: default, appendinplace, илиjson

-t, --target струна

    Если применимо, целевой объект пакета для использования