REST API 2.0 REST API 2.0

Databricks REST API 2.0 では、ワークスペース、DBFS、クラスター、インスタンス プール、ジョブ、ライブラリ、ユーザーとグループ、トークン、MLflow の実験とモデルを管理するためのサービスがサポートされています。The Databricks REST API 2.0 supports services to manage your workspace, DBFS, clusters, instance pools, jobs, libraries, users and groups, tokens, and MLflow experiments and models.

この記事では、REST API の使用方法の概要について説明します。This article provides an overview of how to use the REST API. 各 API リファレンス、認証オプション、および例へのリンクは、この記事の最後に記載されています。Links to each API reference, authentication options, and examples are listed at the end of the article.

個人用アクセス トークンを使用した REST API に対する認証の詳細については、「Azure Databricks 個人用アクセス トークンを使用して認証する」を参照してください。For information about authenticating to the REST API using personal access tokens, see Authentication using Azure Databricks personal access tokens. API の例については、「API の例」を参照してください。For API examples, see API examples.

Azure Active Directory トークンを使用した REST API に対する認証の詳細については、「Azure Active Directory トークンを使用して認証する」を参照してください。For information about authenticating to the REST API using Azure Active Directory tokens, see Authenticate using Azure Active Directory tokens. 例については、ユーザーに対する Azure AD アクセス トークンの使用およびサービス プリンシパルに対する Azure AD アクセス トークンの使用に関する記事を参照してください。For examples, see Use an Azure AD access token for a user and Use an Azure AD access token for a service principal.

転送率の制限Rate limits

負荷が高い状態でのサービスの高品質を確保するために、Databricks ではすべての REST API 呼び出しに対してレート制限が適用されます。To ensure high quality of service under heavy load, Databricks enforces rate limits for all REST API calls. 制限は、公平な使用と高可用性を確保するために、エンドポイントごとおよびワークスペースごとに設定されます。Limits are set per endpoint and per workspace to ensure fair usage and high availability. 制限の引き上げを要求するには、Databricks 担当者にお問い合わせください。To request a limit increase, contact your Databricks representative.

レート制限を超える要求には、429 応答状態コードが返されます。Requests that exceed the rate limit return a 429 response status code.

出力を解析するParse output

JSON 出力の一部を解析すると便利な場合があります。It can be useful to parse out parts of the JSON output. このような場合は、jq ユーティリティを使用することをお勧めします。In these cases, we recommend that you to use the utility jq. 詳細については、jq のマニュアルを参照してください。For more information, see the jq Manual. brew install jq を実行することにより、Homebrew を使用して MacOS に jq をインストールできます。You can install jq on MacOS using Homebrew by running brew install jq.

一部の STRING フィールド (UI で使用するためのエラー/説明メッセージを含む) は構造化されていないため、プログラムによるワークフローではこれらのフィールドの形式に依存できません。Some STRING fields (which contain error/descriptive messaging intended to be consumed by the UI) are unstructured, and you should not depend on the format of these fields in programmatic workflows.

クエリ文字列を使用して GET を呼び出すInvoke a GET using a query string

ほとんどの API 呼び出しでは JSON 本文を指定する必要がありますが、GET の呼び出しではクエリ文字列を指定できます。While most API calls require that you specify a JSON body, for GET calls you can specify a query string.

以下の例では、<databricks-instance> を Azure Databricks デプロイのワークスペース URL に置き換えます。In the following examples, replace <databricks-instance> with the workspace URL of your Azure Databricks deployment. <databricks-instance>adb- で始まる必要があります。<databricks-instance> should start with adb-. <azure-region-name> で始まる非推奨のリージョンの URL は使用しないでください。Do not use the deprecated regional URL starting with <azure-region-name>. 新しいワークスペースでは機能しない可能性があり、信頼性が低く、ワークスペースごとの URL よりパフォーマンスが低下します。It may not work for new workspaces, will be less reliable, and will exhibit lower performance than per-workspace URLs.

クラスターの詳細を取得するには、以下を実行します。To get the details for a cluster, run:

curl ... https://<databricks-instance>/api/2.0/clusters/get?cluster_id=<cluster-id>

DBFS ルートの内容を一覧表示するには、以下を実行します。To list the contents of the DBFS root, run:

curl ... https://<databricks-instance>/api/2.0/dbfs/list?path=/

ランタイム バージョン文字列 Runtime version strings

多くの API 呼び出しでは、Databricks ランタイム バージョン文字列を指定する必要があります。Many API calls require you to specify a Databricks runtime version string. このセクションでは、Databricks REST API のバージョン文字列の構造について説明します。This section describes the structure of a version string in the Databricks REST API.

Databricks ランタイムDatabricks Runtime

<M>.<F>.x[-cpu][-gpu][-ml][-hls][conda]-scala<scala-version>

wherewhere

  • M - Databricks Runtime メジャー リリースM - Databricks Runtime major release
  • F - Databricks Runtime 機能リリースF - Databricks Runtime feature release
  • cpu - CPU バージョン (-ml のみを使用)cpu - CPU version (with -ml only)
  • gpu - GPU 対応gpu - GPU-enabled
  • ml - 機械学習ml - Machine learning
  • hls - Genomicshls - Genomics
  • conda - Conda で使用 (使用できなくなりました)conda - with Conda (no longer available)
  • scala-version - Spark のコンパイルに使用された Scala のバージョン。2.10、2.11、または 2.12scala-version - version of Scala used to compile Spark: 2.10, 2.11, or 2.12

たとえば、5.5.x-scala2.106.3.x-gpu-scala2.11す。For example, 5.5.x-scala2.10 and 6.3.x-gpu-scala2.11. サポートされるリリース」と「サポート終了履歴」の表では、Databricks Runtime のバージョンが、ランタイムに含まれる Spark のバージョンにマップされます。The Supported releases and End-of-support history tables map Databricks Runtime versions to the Spark version contained in the runtime.

Databricks LightDatabricks Light

apache-spark.<M>.<F>.x-scala<scala-version>

wherewhere

  • M - Apache Spark メジャー リリースM - Apache Spark major release
  • F - Apache Spark 機能リリースF - Apache Spark feature release
  • scala-version - Spark のコンパイルに使用された Scala のバージョン。2.10 または 2.11scala-version - version of Scala used to compile Spark: 2.10 or 2.11

たとえば、「 apache-spark-2.4.x-scala2.11 」のように入力します。For example, apache-spark-2.4.x-scala2.11.

APIAPIs