ワークスペース、クラスター、ノートブック、モデル、およびジョブの識別子を取得するGet workspace, cluster, notebook, model, and job identifiers

この記事では、Azure Databricks でワークスペース、クラスター、モデル、ノートブック、ジョブの識別子と Url を取得する方法について説明します。This article explains how to get workspace, cluster, model, notebook, and job identifiers and URLs in Azure Databricks.

ワークスペースのインスタンス名、url、 および id Workspace instance names, URLs, and IDs

一意の インスタンス名( ワークスペースごとの URL とも呼ばれます) は、各 Azure Databricks デプロイに割り当てられます。A unique instance name, also known as a per-workspace URL, is assigned to each Azure Databricks deployment. これは、Azure Databricks デプロイにログインして API 要求を行うために使用される完全修飾ドメイン名です。It is the fully-qualified domain name used to log into your Azure Databricks deployment and make API requests.

Azure Databricks ワークスペース は、Azure Databricks プラットフォームが実行され、Spark クラスターを作成してワークロードをスケジュールできる場所です。An Azure Databricks workspace is where the Azure Databricks platform runs and where you can create Spark clusters and schedule workloads. ワークスペースには一意の数値ワークスペース ID があります。A workspace has a unique numerical workspace ID.

ワークスペースごとの URLPer-workspace URL

一意のワークスペースごとの URL の形式は adb-<workspace-id>.<random-number>.azuredatabricks.net です。The unique per-workspace URL has the format adb-<workspace-id>.<random-number>.azuredatabricks.net. ワークスペース ID は、 adb- "ドット" (.) の直後および前に表示されます。The workspace ID appears immediately after adb- and before the “dot” (.). ワークスペースごとの URL https://adb-5555555555555555.19.azuredatabricks.net/ :For the per-workspace URL https://adb-5555555555555555.19.azuredatabricks.net/:

  • インスタンス名が adb-5555555555555555.19.azuredatabricks.net です。The instance name is adb-5555555555555555.19.azuredatabricks.net.
  • ワークスペース ID は 5555555555555555 です。The workspace ID is 5555555555555555.

ワークスペースごとの URL の決定Determine per-workspace URL

ワークスペースごとの URL は次のように決定できます。You can determine the per-workspace URL for your workspace:

レガシリージョンの URL Legacy regional URL

重要

レガシリージョンの Url は使用しないでください。Avoid using legacy regional URLs. 新しいワークスペースでは機能しない可能性があり、信頼性が低く、ワークスペースの Url ごとのパフォーマンスが低下します。They may not work for new workspaces, are less reliable, and exhibit lower performance than per-workspace URLs.

レガシリージョンの URL は、Azure Databricks ワークスペースがデプロイされているリージョンとドメイン (など) で構成され azuredatabricks.net https://westus.azuredatabricks.net/ ます。The legacy regional URL is composed of the region where the Azure Databricks workspace is deployed plus the domain azuredatabricks.net, for example, https://westus.azuredatabricks.net/.

  • などの従来の地域 URL にログインした場合 https://westus.azuredatabricks.net/ 、インスタンス名はに westus.azuredatabricks.net なります。If you log in to a legacy regional URL like https://westus.azuredatabricks.net/, the instance name is westus.azuredatabricks.net.
  • ワークスペース ID は、レガシリージョンの URL を使用してログインした後にのみ、URL に表示されます。The workspace ID appears in the URL only after you have logged in using a legacy regional URL. は、の後に表示され o= ます。It appears after the o=. URL で https://<databricks-instance>/?o=6280049833385130 は、ワークスペース ID は 6280049833385130 です。In the URL https://<databricks-instance>/?o=6280049833385130, the workspace ID is 6280049833385130.

クラスター URL と IDCluster URL and ID

Azure Databricks クラスター は、運用環境の ETL パイプライン、ストリーミング分析、アドホック分析、機械学習など、さまざまな用途に対応した統合プラットフォームを提供します。An Azure Databricks cluster provides a unified platform for various use cases such as running production ETL pipelines, streaming analytics, ad-hoc analytics, and machine learning. 各クラスターには、クラスター ID と呼ばれる一意の ID があります。Each cluster has a unique ID called the cluster ID. これは、すべての目的とジョブのクラスターに適用されます。This applies to both all-purpose and job clusters. REST API を使用してクラスターの詳細を取得するには、クラスター ID が必要です。To get the details of a cluster using the REST API, the cluster ID is essential.

クラスター ID を取得するには、サイドバーの [ クラスター ] タブをクリックし、クラスター名を選択します。To get the cluster ID, click the Clusters tab in sidebar and then select a cluster name. クラスター ID は、 /clusters/ このページの URL に含まれるコンポーネントの後の番号です。The cluster ID is the number after the /clusters/ component in the URL of this page

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

次のスクリーンショットでは、クラスター ID は 0831-211914-clean632 です。In the following screenshot, the cluster ID is 0831-211914-clean632.

クラスター URLCluster URL

Notebook の URL と ID Notebook URL and ID

Notebook は、実行可能なコード、視覚エフェクト、およびナレーションテキストを含むドキュメントへの web ベースのインターフェイスです。A notebook is a web-based interface to a document that contains runnable code, visualizations, and narrative text. Notebook は、Azure Databricks と対話するための1つのインターフェイスです。Notebooks are one interface for interacting with Azure Databricks. 各ノートブックには一意の ID があります。Each notebook has a unique ID. Notebook の URL は notebook ID であるため、ノートブックの URL はノートブックに固有です。The notebook URL has the notebook ID, hence the notebook URL is unique to a notebook. ノートブックを表示および編集するアクセス許可を持つ Azure Databricks プラットフォームのすべてのユーザーと共有できます。It can be shared with anyone on Azure Databricks platform with permission to view and edit the notebook. さらに、各 notebook コマンド (セル) の URL が異なります。In addition, each notebook command (cell) has a different URL.

ノートブックの URL にアクセスするには、notebook を開きます。To get to a notebook URL, open a notebook.

次のノートブックでは、notebook の URL は https://westus.azuredatabricks.net/?o=6280049833385130#notebook/1940481404050342 、NOTEBOOK ID は 1940481404050342 、コマンド (セル) の url はです。In the following notebook, the notebook URL is https://westus.azuredatabricks.net/?o=6280049833385130#notebook/1940481404050342, the notebook ID is 1940481404050342, and the command (cell) URL is

https://westus.azuredatabricks.net/?o=6280049833385130#notebook/1940481404050342/command/2432220274659491

ノートブック URLNotebook URL

モデル IDModel ID

モデルとは、MLflow に 登録されているモデル を指します。これにより、ステージ遷移とバージョン管理を通じて、運用環境で Mlflow モデルを管理できます。A model refers to an MLflow registered model, which lets you manage MLflow Models in production through stage transitions and versioning. 登録されているモデル ID は、 アクセス許可 APIを使用して、モデルのアクセス許可をプログラムで変更するために必要です。The registered model ID is required for changing the permissions on the model programmatically through the Permissions API.

登録されているモデルの ID を取得するには、 REST API 2.0 エンドポイントを使用でき mlflow/databricks/registered-models/get ます。To get the ID of a registered model, you can use the REST API 2.0 endpoint mlflow/databricks/registered-models/get. たとえば、次のコードは、登録されているモデルオブジェクトとそのプロパティ (ID を含む) を返します。For example, the following code returns the registered model object with its properties, including its 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

返される値の形式は次のとおりです。The returned value has the format:

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

ジョブ URL と IDJob URL and ID

ジョブ とは、すぐに、またはスケジュールに従って notebook または JAR を実行する方法です。A job is a way of running a notebook or JAR either immediately or on a scheduled basis.

ジョブの URL にアクセスするには、サイドバーの [ ジョブ ] タブをクリックし、ジョブ名をクリックします。To get to a job URL, click the Jobs tab in sidebar and click a job name. このジョブの URL は、失敗したジョブの実行をトラブルシューティングし、根本原因を調査するために必要な情報です。This job URL is critical piece of information needed to troubleshoot job runs that have failed and investigate the root cause.

次のスクリーンショットでは、ジョブの URL は https://westus.azuredatabricks.net/?o=6280049833385130#job/1 で、ジョブ ID は 1 です。In the following screenshot, the job URL is https://westus.azuredatabricks.net/?o=6280049833385130#job/1, and the job ID is 1.

ジョブ URLJob URL