次の方法で共有

api コマンド グループ

  • [アーティクル]

Note

この情報は、パブリック プレビュー段階である Databricks CLI バージョン 0.205 以降に当てはまる内容です。 お使いの Databricks CLI のバージョンを確認するには、databricks -v を実行してください。

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

api コマンド グループの実行は、高度なシナリオの場合のみにしてください (特定の Databricks REST API がプレビュー リリースであり、Databricks CLI で、まだ関連コマンドでその対象 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、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": "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"
}