メインコンテンツまでスキップ

api コマンド グループ

注記

この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI は パブリック プレビュー段階です。

Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。

Databricks CLI 内の api コマンド グループを使用すると、使用可能な任意の Databricks REST API を呼び出すことができます。

実行 api コマンドは、Databricks CLIがターゲット Databricks REST APIを関連コマンド内にラップしていない特定のDatabricks REST APIsのプレビュー リリースなどの高度なシナリオでのみ実行する必要があります。コマンド グループの一覧については、「コマンドDatabricks CLI」を参照してください。

databricks api delete​

DELETE要求の実行

databricks api delete PATH [flags]

引数​

PATH

API エンドポイント パス

オプション​

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path

グローバルフラグ

例​

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

databricks api get​

GET 要求の実行

databricks api get PATH [flags]

引数​

PATH

API エンドポイント パス

オプション​

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path

グローバルフラグ

例​

次の例では、ワークスペースで使用可能なクラスターのリストを取得します。

Bash
databricks api get /api/2.0/clusters/list

次の例では、ジョブを取得します。

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

databricks api head​

HEAD 要求の実行

databricks api head PATH [flags]

引数​

PATH

API エンドポイント パス

オプション​

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path

グローバルフラグ

例​

Bash
databricks api head /api/2.0/clusters/list

databricks api patch​

PATCHリクエストの実行

databricks api patch PATH [flags]

引数​

PATH

API エンドポイント パス

オプション​

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path

グローバルフラグ

例​

Bash
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]

引数​

PATH

API エンドポイント パス

オプション​

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path

グローバルフラグ

例​

次の例では、ワークスペースで指定されたクラスターに関する情報を取得します。

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

次の例では、クラスターを作成します。

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

ワークスペース内の指定したクラスターの設定を更新します。

Bash
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": "i3.xlarge"
}'

ワークスペース内の指定したクラスターの設定を更新します。 現在の作業ディレクトリ内の edit-cluster.json という名前のファイルから要求本文を取得します。

Bash
databricks api post /api/2.0/clusters/edit --json @edit-cluster.json

edit-cluster.json:

JSON
{
  "cluster_id": "1234-567890-abcde123",
  "cluster_name": "my-changed-cluster",
  "num_workers": 1,
  "spark_version": "11.3.x-scala2.12",
  "node_type_id": "i3.xlarge"
}

databricks api put​

PUT要求の実行

databricks api put PATH [flags]

引数​

PATH

API エンドポイント パス

オプション​

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path

グローバルフラグ

例​

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

グローバルフラグ​

--debug

デバッグログを有効にするかどうか。

-h または --help

Databricks CLI、関連するコマンド グループ、または関連するコマンドのヘルプを表示します。

--log-file string

出力ログの書き込み先となるファイルを表す文字列。このフラグが指定されていない場合、デフォルトでは出力ログが stderr に書き込まれます。

--log-format format

ログ・フォーマット・タイプ ( text または json) 。デフォルト値は textです。

--log-level string

ログ形式レベルを表す文字列。指定しない場合、ログ・フォーマット・レベルは使用不可になります。

-o, --output タイプ

コマンド出力タイプ text または json。デフォルト値は textです。

-p, --profile string

コマンドの実行に使用する ~/.databrickscfg ファイル内のプロファイルの名前。このフラグが指定されていない場合、存在する場合は、 DEFAULT という名前のプロファイルが使用されます。

--progress-format format

進行状況ログを表示する形式: default、 append、 inplace、 json

-t, --target string

該当する場合は、使用するバンドル・ターゲット

に最終更新