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

Note

Эта информация относится к Интерфейсу командной строки Databricks версии 0.205 и выше. Интерфейс командной строки Databricks находится в общедоступной предварительной версии.

Использование интерфейса командной строки Databricks подчиняется лицензии Databricks и уведомлению о конфиденциальности Databricks, включая любые положения о данных использования.

Группа api команд в интерфейсе командной строки Databricks позволяет вызывать любой доступный REST API Databricks.

Вы должны выполнить 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 или JSON-файл @path с текстом запроса

Глобальные флаги

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 или JSON-файл @path с текстом запроса

Глобальные флаги

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 или JSON-файл @path с текстом запроса

Глобальные флаги

Examples

databricks api head /api/2.0/clusters/list

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

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

databricks api patch PATH [flags]

Arguments

PATH

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

Options

--json JSON

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

Глобальные флаги

Examples

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

Пост api Databricks

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

databricks api post PATH [flags]

Arguments

PATH

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

Options

--json JSON

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

Глобальные флаги

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

запрос PUT к API Databricks

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

databricks api put PATH [flags]

Arguments

PATH

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

Options

--json JSON

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

Глобальные флаги

Examples

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

Глобальные флаги

--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 струна

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