api 命令群組

注意

此資訊適用於處於公開預覽狀態 的 Databricks CLI 0.205 版和更新版本。 若要尋找 Databricks CLI 版本請執行 databricks -v。

api Databricks CLI 內的命令群組可讓您呼叫任何可用的 Databricks REST API。

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

重要

若要安裝 Databricks CLI，請參閱 安裝或更新 Databricks CLI。 若要設定 Databricks CLI 的驗證，請參閱 Databricks CLI 的驗證。

執行 api 指令（僅適用於進階案例）

api您可以將命令附加至 來執行databricks api命令。 若要顯示命令的說明 api ，請執行 databricks api -h。

若要呼叫 api 命令，請使用下列格式：

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

在上述呼叫中：

• 將 取代<http-method>為您想要呼叫之 Databricks REST API 的 HTTP 方法，例如 delete、、gethead、path、 post或 put。 例如，若要傳回工作區可用的叢集清單，請使用 get。 若要取得您想要呼叫之 Databricks REST API 的正確 HTTP 方法，請參閱 Databricks REST API 檔。
• 將 取代 <rest-api-path> 為您想要呼叫之 Databricks REST API 的路徑。 請勿包含 https:// 或工作區實例名稱。 例如，若要傳回工作區可用的叢集清單，請使用 /api/2.0/clusters/list。 若要取得您想要呼叫之 Databricks REST API 的正確語法，請參閱 Databricks REST API 檔。
• 如果您要呼叫的 Databricks REST API 需要要求本文，請包含 --json 和 <request-body>，並以 <request-body> JSON 格式的要求本文取代 。 或者，您可以將要求本文儲存在個別的 JSON 檔案中。 若要這樣做，請包含 --json 和 @<filename>，並以 <filename> JSON 檔案的名稱取代 。 若要取得您想要包含之要求本文的正確語法，請參閱 Databricks REST API 檔。

範例

取得工作區中可用叢集的清單。

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