Obtener identificadores para objetos del área de trabajo

Artículo
03/01/2024

En este artículo se explica cómo obtener los identificadores y las direcciones URL de las áreas de trabajo, los clústeres, las carpetas, los modelos, los cuadernos y los trabajos de Azure Databricks.

Nombres, direcciones URL e identificadores de instancias de áreas de trabajo

A cada implementación de Azure Databricks se asigna un nombre de instancia único, también conocido como dirección URL por área de trabajo. Se trata del nombre de dominio completo que se usa para iniciar sesión en la implementación de Azure Databricks y realizar solicitudes de API.

Un área de trabajo de Azure Databricks es donde se ejecuta la plataforma de Azure Databricks y donde usted puede crear clústeres de Spark y programar cargas de trabajo. Un área de trabajo tiene un id. numérico único.

Dirección URL por área de trabajo

Esta dirección URL por área de trabajo única tiene el formato adb-<workspace-id>.<random-number>.azuredatabricks.net. El id. de área de trabajo aparece inmediatamente después adb- y antes del "punto" (.). Para la dirección URL por área de trabajo https://adb-5555555555555555.19.azuredatabricks.net/:

El nombre de instancia es adb-5555555555555555.19.azuredatabricks.net.
El id. de área de trabajo es 5555555555555555.

Determinación de la dirección URL por área de trabajo

Puede determinar la dirección URL por área de trabajo de su área de las siguientes formas:

En el explorador cuando haya iniciado sesión:
En Azure Portal, seleccionando el recurso y observando el valor del campo Dirección URL:
Mediante Azure API. Consulte Obtención de una dirección URL por área de trabajo mediante Azure API.

Dirección URL regional heredada

Importante

Evite usar direcciones URL regionales heredadas. Es posible que no funcionen en las nuevas áreas de trabajo, que sean menos confiables y que muestren un rendimiento inferior al de las direcciones URL por área de trabajo.

La dirección URL regional heredada se compone de la región donde se implementa el área de trabajo de Azure Databricks más el dominio azuredatabricks.net, por ejemplo, https://westus.azuredatabricks.net/.

Si inicia sesión en una dirección URL regional heredada como https://westus.azuredatabricks.net/, el nombre de instancia es westus.azuredatabricks.net.
El id. de área de trabajo solo aparece en la dirección URL después de haber iniciado sesión con una dirección URL regional heredada. Aparece después de o=. En la dirección URL https://<databricks-instance>/?o=6280049833385130, el id. de área de trabajo es 6280049833385130.

Dirección URL e identificador del clúster

Un clúster de Azure Databricks proporciona una plataforma unificada para varios casos de uso, como ejecución de canalizaciones ETL de producción, análisis de streaming, análisis ad hoc y aprendizaje automático. Cada clúster tiene un id. único denominado "id. de clúster". Esto se aplica tanto a los clústeres de uso general como a los de trabajo. Para obtener los detalles de un clúster mediante la API de REST, es esencial conocer su id.

Para obtener el id. de clúster, haga clic en la pestaña Clústeres de la barra lateral y, a continuación, seleccione un nombre de clúster. El id. de clúster es el número que aparece después del componente /clusters/ en la dirección URL de esta página.

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

En la siguiente captura de pantalla, el id. de clúster es 0831-211914-clean632.

Cluster URL

Dirección URL e identificador del cuaderno

Un cuaderno es una interfaz basada en web para un documento que contiene código ejecutable, visualizaciones y texto narrativo. Los cuadernos ofrecen una sola interfaz para interactuar con Azure Databricks. Cada cuaderno tiene un id. único. La dirección URL de un cuaderno tiene su id., por lo que también es única. Se puede compartir con cualquier usuario de la plataforma de Azure Databricks con permiso para ver y editar el cuaderno. Además, cada comando de cuaderno (celda) tiene una dirección URL diferente.

Para buscar una dirección URL o un Id. de cuaderno, abra un cuaderno. Para buscar una dirección URL de celda, haga clic en el contenido del comando.

Ejemplo de dirección URL de cuaderno:

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

Ejemplo de Id. de cuaderno: 1940481404050342.

Ejemplo de dirección URL de comando (celda):

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

Id. de carpeta

Una carpeta es un directorio en el que se almacenan archivos que se pueden usar en un área de trabajo de Azure Databricks. Estos archivos pueden ser cuadernos, bibliotecas o subcarpetas. Cada carpeta y subcarpeta individual poseen un id. específico asociado. En Permissions API, este tipo de id. se referencia mediante el elemento directory_id y se usa a la hora de configurar y actualizar los permisos de una carpeta.

Para recuperar el elemento directory_id, ejecute el siguiente comando en 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

A continuación se muestra un ejemplo de la respuesta de la llamada API:

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

Id. de modelo

Un modelo hace referencia a un modelo registrado de MLflow, que permite administrar modelos de MLflow en producción a través de transiciones de fase y el control de versiones. Se necesita el id. de modelo registrado para cambiar sus permisos mediante programación a través de Permissions API.

Para obtener el id. de un modelo registrado, puede usar el punto de conexión mlflow/databricks/registered-models/get de la API de área de trabajo. Por ejemplo, el siguiente código devuelve el objeto de modelo registrado con sus propiedades, incluido su 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

El valor devuelto tiene el siguiente formato:

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

Dirección URL e identificador del trabajo

Un trabajo es una forma de ejecutar un cuaderno o JAR, ya sea inmediatamente o de acuerdo con una programación.

Para obtener la dirección URL de un trabajo, haga clic en Flujos de trabajo en la barra lateral y haga clic en el nombre de un trabajo. El id. de trabajo aparece después del texto #job/ en la dirección URL. La dirección URL del trabajo es necesaria para solucionar la causa principal de las ejecuciones de trabajos con errores.

En la siguiente captura de pantalla, la dirección URL de trabajo es:

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

En este ejemplo, el id. de trabajo es 1.

Job URL