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 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、get、head、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": "i3.xlarge"
}'

ワークスペース内の指定したクラスターの設定を更新します。 現在の作業ディレクトリ内の 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": "i3.xlarge"
}