api 命令群組

api Databricks CLI 中的指令群組允許您呼叫任何可用的 Databricks REST API。

您應該只針對進階案例執行 api 命令，例如 Databricks CLI 尚未在相關命令中包裝目標 Databricks REST API 的特定 Databricks REST API 預覽版本。 如需命令群組的清單，請參閱 Databricks CLI 命令。

databricks API 刪除

執行 DELETE 要求

databricks api delete PATH [flags]

Arguments

PATH

    API 端點路徑

選項

--json JSON

    內嵌 JSON 字串或 @path 指向 JSON 檔案的要求本文

全域旗標

Examples

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

Databricks API 獲取

執行 GET 要求

databricks api get PATH [flags]

Arguments

PATH

    API 端點路徑

選項

--json JSON

    內嵌 JSON 字串或 @path 指向 JSON 檔案的要求本文

全域旗標

Examples

下列範例會取得工作區中可用叢集的清單：

databricks api get /api/2.0/clusters/list

下列範例會取得工作：

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

databricks API 前端

執行 HEAD 要求

databricks api head PATH [flags]

Arguments

PATH

    API 端點路徑

選項

--json JSON

    內嵌 JSON 字串或 @path 指向 JSON 檔案的要求本文

全域旗標

Examples

databricks api head /api/2.0/clusters/list

databricks API 更新

執行 PATCH 要求

databricks api patch PATH [flags]

Arguments

PATH

    API 端點路徑

選項

--json JSON

    內嵌 JSON 字串或 @path 指向 JSON 檔案的要求本文

全域旗標

Examples

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

databricks API POST請求

執行 POST 要求

databricks api post PATH [flags]

Arguments

PATH

    API 端點路徑

選項

--json JSON

    內嵌 JSON 字串或 @path 指向 JSON 檔案的要求本文

全域旗標

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

databricks API put

執行 PUT 要求

databricks api put PATH [flags]

Arguments

PATH

    API 端點路徑

選項

--json JSON

    內嵌 JSON 字串或 @path 指向 JSON 檔案的要求本文

全域旗標

Examples

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

全域旗標

--debug

  是否要啟用偵錯記錄。

-h 或 --help

    顯示 Databricks CLI、相關命令群組或相關命令的幫助說明。

--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 字串

    如果適用，要使用的套件組合目標