Поделиться через

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

  • Статья

Примечание.

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

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

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

Внимание

Чтобы установить интерфейс командной строки Databricks, см. статью "Установка или обновление интерфейса командной строки Databricks". Сведения о настройке проверки подлинности для интерфейса командной строки Databricks см. в разделе "Проверка подлинности" для интерфейса командной строки Databricks.

Команды выполнения api (только для расширенных сценариев)

Команды выполняются api путем добавления их в databricks api. Чтобы отобразить справку по команде api , выполните команду databricks api -h.

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

databricks api <http-method> <rest-api-path> [--json {<request-body> | @<filename>}]

В предыдущем вызове:

  • Замените <http-method> метод HTTP для REST API Databricks, который требуется вызвать, например delete, , get, headpathили postput. Например, чтобы вернуть список доступных кластеров для рабочей области, используйте get. Чтобы получить правильный метод HTTP для REST API Databricks, который требуется вызвать, см. документацию по REST API Databricks.
  • Замените <rest-api-path> путь к REST API Databricks, который требуется вызвать. Не включать https:// или имя экземпляра рабочей области. Например, чтобы вернуть список доступных кластеров для рабочей области, используйте /api/2.0/clusters/list. Чтобы получить правильный синтаксис REST API Databricks, который требуется вызвать, см. документацию по REST API Databricks.
  • Если REST API Databricks, который требуется вызвать, требуется текст запроса, включите --json и <request-body>замените <request-body> текст запроса в формате JSON. Кроме того, текст запроса можно хранить в отдельном JSON-файле. Для этого включите --json и @<filename>замените <filename> имя JSON-файла. Чтобы получить правильный синтаксис для текста запроса, который требуется включить, см. документацию по REST API Databricks.

Примеры

Получите список доступных кластеров в рабочей области.

databricks api get /api/2.0/clusters/list

Получение сведений об указанном кластере в рабочей области.

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

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

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