Obtenir des identifiants pour les objets Workspace

Cet article explique comment obtenir les identifiants et les URL de Workspace, de compute classique, de tableau de bord, de répertoire, de modèle, de Notebook et de Job dans Databricks.

Noms d'instance, URL et ID du Workspace

Un nom d'instance est attribué à chaque déploiement Databricks. Pour séparer la charge de travail et n'accorder l'accès qu'aux utilisateurs concernés, les clients Databricks créent généralement des instances distinctes pour le développement, la préproduction et la production. Le nom de l'instance est la première partie de l'URL lorsque vous vous connectez à votre déploiement Databricks :

Si vous vous connectez à https://cust-success.cloud.databricks.com/, alors :

• L'*URL du workspace* https://cust-success.cloud.databricks.com/ est.
• Le nom d'instance est cust-success.cloud.databricks.com.

Un Workspace Databricks est l'endroit où la plateforme Databricks s'exécute et où vous pouvez créer des clusters Spark et planifier des charges de travail. Certains types de workspaces ont un ID de Workspace unique. S'il y a o= dans l'URL de déploiement, par exemple, https://<databricks-instance>/?o=6280049833385130, le nombre aléatoire après o= est l'ID du Workspace Databricks. L'ID du Workspace est 6280049833385130. S'il n'y a pas de o= dans l'URL de déploiement, l'ID du Workspace est 0.

URL régionale ancienne

important

Évitez les URL régionales anciennes. Ils :

• Peut ne pas fonctionner avec de nouveaux Workspace.
• Sont moins fiables et plus lentes que les URL par Workspace.
• Peut casser des fonctionnalités qui nécessitent des ID de Workspace.

L'URL régionale héritée est composée de la région où le workspace Databricks est déployé plus le domaine cloud.databricks.com, par exemple, https://oregon.cloud.databricks.com/.

• Si vous vous connectez à une URL régionale héritée comme https://oregon.cloud.databricks.com/, le nom de l'instance est oregon.cloud.databricks.com.
• L'ID du workspace apparaît dans l'URL uniquement après vous être connecté à l'aide d'une URL régionale héritée. Il apparaît après le o=. Dans l'URL https://<databricks-instance>/?o=6280049833385130, l'ID du workspace est 6280049833385130.

URL et ID de ressource de compute

Les ressources compute Databricks fournissent une plateforme unifiée pour divers cas d'utilisation tels que l'exécution de pipelines ETL de production, l'analytique en streaming, l'analytique ad hoc et le Machine Learning. Chaque ressource de compute classique possède un ID unique appelé l'ID de cluster. Cela s'applique aux clusters polyvalents et aux clusters Job, mais pas au compute serverless. Vous avez besoin de l'ID du cluster pour obtenir les détails d'un cluster à l'aide de l'API REST.

Pour obtenir l’ID de cluster, cliquez sur Compute dans la barre latérale, puis sélectionnez un nom de cluster. L’ID de cluster est le nombre après le composant /clusters/ dans l’URL de cette page.

https://<databricks-instance>/compute/clusters/<cluster-id>

Dans la capture d'écran suivante, l'ID de cluster est le 0807-000654-abcdefgh:

URL et ID du tableau de bord

Un tableau de bord AI/BI est une présentation de visualisations de données et de commentaires. Chaque tableau de bord possède un ID unique. Vous pouvez utiliser cet ID pour créer des liens directs qui incluent des valeurs de filtre et de paramètre prédéfinies, ou accéder au tableau de bord à l’aide de l’API REST.

• Exemple d'URL de tableau de bord :

  https://cust-success.cloud.databricks.com/sql/dashboardsv3/01ef9214fcc7112984a50575bf2b460f

• Exemple d'ID de tableau de bord : 01ef9214fcc7112984a50575bf2b460f

URL et ID du Notebook

Un Notebook est une interface Web vers un document qui contient du code exécutable, des visualisations et du texte narratif. Les Notebooks sont une interface pour interagir avec Databricks. Chaque Notebook possède un ID unique. L'URL du Notebook contient l'ID du Notebook, ce qui la rend unique pour un Notebook. Il peut être partagé avec toute personne sur la plateforme Databricks qui a l'autorisation de consulter et de modifier le notebook. De plus, chaque commande (cellule) de Notebook a une URL différente.

Pour trouver l'URL ou l'ID d'un Notebook, ouvrez un Notebook. Pour trouver une URL de cellule, cliquez sur le contenu de la commande.

• URL de l'exemple de Notebook :

  https://cust-success.cloud.databricks.com/#notebook/333096

• ID de l'exemple de notebook : 333096.

• Exemple : URL de commande (cellule)

  https://cust-success.cloud.databricks.com/#notebook/333096/command/333099

ID du dossier

Un dossier est un répertoire utilisé pour stocker des fichiers pouvant être utilisés dans le Databricks Workspace. Ces fichiers peuvent être des notebooks, des bibliothèques ou des sous-dossiers. Il existe un ID spécifique associé à chaque dossier et à chaque sous-dossier individuel. L'API des autorisations fait référence à cet ID en tant que directory_id et est utilisée pour définir et mettre à jour les autorisations d'un dossier.

Pour récupérer l'ID de répertoire, utilisez l'API du Workspace :

Bash

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

Ceci est un exemple de la réponse de l'appel d'API :

JSON

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

ID de modèle

Un modèle fait référence à un modèle enregistré MLflow, qui vous permet de gérer les modèles MLflow en production par le biais de transitions de phase et de gestion de versions. L'ID du modèle enregistré est requis pour modifier les autorisations sur le modèle par programmation via l'API de permissions.

Pour obtenir l'ID d'un modèle enregistré, vous pouvez utiliser l'endpoint mlflow/databricks/registered-models/get de l'API du Workspace. Par exemple, le code suivant renvoie l'objet de modèle enregistré avec ses propriétés, y compris son ID :

Bash

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

La valeur renvoyée a le format suivant :

JSON

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

URL du job et ID

Un job est un moyen d’exécuter un notebook ou un JAR immédiatement ou selon un calendrier.

Pour obtenir l’URL d’un job, cliquez sur **Jobs et Pipelines** dans la barre latérale, puis cliquez sur un nom de job. L'ID du Job apparaît après /jobs/ dans l'URL. Utilisez l'URL du Job pour accéder à un Job et à l'historique de son exécution. Pour Link directement à une exécution spécifique, par exemple pour partager dans un ticket de support, utilisez plutôt l'URL d'exécution. Consultez l'URL et l'ID d'exécution de Job.

Dans la capture d'écran suivante, l'URL du Job est :

https://<workspace-name>.cloud.databricks.com/jobs/739153693773

Dans cet exemple, l'ID de job est 739153693773.

URL et ID d'exécution du Job

Un seul Job peut avoir plusieurs exécutions. Chaque exécution possède son propre *ID d'exécution* unique et sa propre URL, qui sont distincts de l'ID du Job et de l'URL du Job. Lorsque vous partagez un Link vers une exécution spécifique, par exemple, dans un ticket de support, utilisez l'URL de l'exécution plutôt que l'URL du Job afin que le destinataire ouvre la bonne exécution.

L'URL d'exécution est au format suivant :

https://<databricks-instance>/jobs/<job-id>/runs/<run-id>

Pour trouver l'ID d'exécution ou l'URL dans l'interface utilisateur du Workspace :

• Dans la **tab Runs** d'un Job, cliquez sur le Link dans la colonne **Heure de start** pour ouvrir la page **Détails de l'exécution du Job**. L'ID d'exécution apparaît dans la barre d'adresse du navigateur après /runs/. Copier l'adresse pour partager l'exécution.
• Sur la page Détails de l'exécution du Job , l'URL dans la barre d'adresse contient l'ID du Job et l'ID de l'exécution sous la forme /jobs/<job-id>/runs/<run-id>.

Pour obtenir l'ID d'exécution ou l'URL par programme :

• Jobs API : Appelez l'endpoint Récupérer l'exécution d'un job. La réponse inclut run_id et run_page_url, qui est le Link direct de l'interface utilisateur vers l'exécution.
• Tables système : La table system.lakeflow.job_run_timeline inclut les colonnes job_id et run_id. Consultez la référence des tables système Jobs.

remarque

Pour les exécutions déclenchées par un autre job, par exemple une tâche qui utilise le type de tâche Exécuter le job, le champ parent_run_id identifie l'exécution parente. Consultez Ajouter des notifications à un job.