ワークスペース オブジェクトの識別子を取得する

  • [アーティクル]

この記事では、Azure Databricks でワークスペース、クラスター、ディレクトリ、モデル、ノートブック、ジョブの識別子と URL を取得する方法について説明します。

ワークスペースのインスタンス名、URL、および ID

一意の "インスタンス名"("ワークスペースごとの URL" とも呼ばれます) は、それぞれの Azure Databricks デプロイに割り当てられています。 これは、Azure Databricks デプロイにログインして API 要求を行うために使用される完全修飾ドメイン名です。

Azure Databricks "ワークスペース" は、Azure Databricks プラットフォームが実行される場所で、そこで Spark クラスターを作成してワークロードをスケジュールできます。 ワークスペースには、一意の数値のワークスペース ID があります。

ワークスペース単位のURL

ワークスペースごとの URL の形式は、adb-<workspace-id>.<random-number>.azuredatabricks.net です。 ワークスペース ID は adb- の直後に置かれ、"ドット" (.) が続きます。 ワークスペースごとの URL https://adb-5555555555555555.19.azuredatabricks.net/ の場合:

  • インスタンス名は adb-5555555555555555.19.azuredatabricks.net です。
  • ワークスペース ID は 5555555555555555 です。

ワークスペースごとの URL を確認する

ワークスペースごとの URL は次のように確認できます。

レガシのリージョン URL

重要

レガシのリージョン URL は使用しないでください。 これらは新しいワークスペースについては機能しないことがあり、信頼性が低く、ワークスペースごとの URL よりもパフォーマンスが低下します。

レガシのリージョン URL は、Azure Databricks ワークスペースがデプロイされているリージョンと、ドメイン azuredatabricks.net (例: https://westus.azuredatabricks.net/) で構成されています。

  • https://westus.azuredatabricks.net/ などのレガシのリージョン URL にログインした場合のインスタンス名は、westus.azuredatabricks.net です。
  • ワークスペース ID が URL 内に現れるのは、レガシのリージョン URL を使用してログインした後だけです。 これは o= の後に現れます。 URL https://<databricks-instance>/?o=6280049833385130 の中で、ワークスペース ID は 6280049833385130 です。

クラスター URL と ID

Azure Databricks "クラスター" は、運用環境の ETL パイプラインの実行、ストリーミング分析、アドホック分析、機械学習など、多様なユース ケースに向けた統合プラットフォームを提供します。 各クラスターには、クラスター ID と呼ばれる一意の ID があります。 これは、汎用クラスターとジョブ クラスターの両方に当てはまります。 REST API を使用してクラスターの詳細を取得するには、クラスター ID が必ず必要です。

クラスター ID を取得するには、サイドバーの [クラスター] タブをクリックしてから、クラスター名を選択します。 クラスター ID は、このページの URL の /clusters/ という構成要素の後にある番号です。

https://<databricks-instance>/#/setting/clusters/<cluster-id>

次のスクリーンショットでは、クラスター ID は 0831-211914-clean632 です。

クラスター URL

ノートブック URL と ID

"ノートブック" は、実行可能なコード、視覚化、説明テキストを含むドキュメントへの Web ベースのインターフェイスです。 ノートブックは、Azure Databricks を操作するための 1 つのインターフェイスです。 各ノートブックには一意の ID があります。 ノートブック URL にはノートブック ID が含まれるため、ノートブック URL はノートブックに固有のものです。 これは、ノートブックを表示して編集するアクセス許可を持っている、Azure Databricks プラットフォーム上のすべてのユーザーと共有できます。 また、各ノートブック コマンド (セル) の URL は異なっています。

ノートブックの URL または ID を見つけるには、ノートブックを開きます。 セルの URL を見つけるには、コマンドの内容をクリックします。

  • ノートブック URL の例:

    https://adb-62800498333851.30.azuredatabricks.net/?o=6280049833385130#notebook/1940481404050342`

  • ノートブック ID の例: 1940481404050342.

  • コマンド (セル) URL の例:

    https://adb-62800498333851.30.azuredatabricks.net/?o=6280049833385130#notebook/1940481404050342/command/2432220274659491

フォルダー ID

フォルダーは、Azure Databricks ワークスペースで使用できるファイルを格納するために使用されるディレクトリです。 これらのファイルには、ノートブック、ライブラリ、またはサブフォルダーを指定できます。 各フォルダーと個々のサブフォルダーに関連付けられた特定の ID があります。 Permissions API は、この ID を directory_id として参照し、フォルダーのアクセス許可の設定と更新に使用されます。

directory_id を取得するには、Workspace API を使用します。

curl -n -X GET -H 'Content-Type: application/json' -d '{"path": "/Users/me@example.com/MyFolder"}' \
https://<databricks-instance>/api/2.0/workspace/get-status

API 呼び出し応答の例を次に示します。

{
  "object_type": "DIRECTORY",
  "path": "/Users/me@example.com/MyFolder",
  "object_id": 123456789012345
}

モデル ID

モデルとは、MLflow 登録済みモデルを指します。これを使用すると、ステージ遷移とバージョン管理を通じて、運用環境で Mlflow モデルを管理できます。 Permissions API を介してモデルに対するアクセス許可をプログラムから変更するためには、登録済みモデルの ID が必要です。

登録済みのモデルの ID を取得するために、Workspace API エンドポイントの mlflow/databricks/registered-models/get を利用できます。 たとえば次のコードでは、ID を含むプロパティと一緒に、登録済みモデルのオブジェクトが返されます。

curl -n -X GET -H 'Content-Type: application/json' -d '{"name": "model_name"}' \
https://<databricks-instance>/api/2.0/mlflow/databricks/registered-models/get

返される値の形式は次のようになっています。

{
  "registered_model_databricks": {
    "name":"model_name",
    "id":"ceb0477eba94418e973f170e626f4471"
  }
}

ジョブ URL と ID

"ジョブ" は、即座に、またはスケジュールに基づいて、ノートブックまたは JAR を実行する方法です。

ジョブの URL を取得するには、サイドバーの [ワークフロー] アイコン[ワークフロー] をクリックして、ジョブ名をクリックします。 ジョブ ID は、URL 内ではテキスト #job/ の後にあります。 失敗したジョブの実行の根本原因をトラブルシューティングするには、ジョブ URL が必要です。

次のスクリーンショットでは、ジョブの URL は次のようになっています。

https://westus.azuredatabricks.net/?o=6280049833385130#job/1

この例では、ジョブ ID は 1 です。

ジョブ URL