Obter identificadores para objetos do workspace

  • Artigo

Este artigo explica como obter identificadores e URLs de workspace, cluster, painel, diretório, modelo, notebook e trabalho no Azure Databricks.

Nomes, URLs e IDs das instâncias de workspace

Um nome de instância exclusivo, também conhecido como uma URL por workspace, é atribuído a cada implantação do Azure Databricks. É o nome de domínio totalmente qualificado usado para fazer logon em sua implantação do Azure Databricks e fazer solicitações de API.

Um workspace do Azure Databricks é onde a plataforma Azure Databricks é executada e onde você pode criar clusters do Spark e agendar cargas de trabalho. Um workspace tem uma ID de workspace numérica exclusiva.

URL por workspace

Essa URL exclusiva por workspace tem o formato adb-<workspace-id>.<random-number>.azuredatabricks.net. A ID do workspace aparece imediatamente após adb- e antes do "ponto" (.). Para a URL por workspace https://adb-5555555555555555.19.azuredatabricks.net/:

  • O nome da instância é adb-5555555555555555.19.azuredatabricks.net.
  • A ID do workspace é 5555555555555555.

Determinar a URL por workspace

É possível determinar a URL por workspace para seu workspace:

URL regional herdada

Importante

Evite usar URLs regionais herdadas. Talvez elas não funcionem em workspaces novos, sejam menos confiáveis e apresentem menor desempenho do que as URLs por workspace.

A URL regional herdada é composta pela região em que o workspace do Azure Databricks é implantado mais o domínio azuredatabricks.net, por exemplo, https://westus.azuredatabricks.net/.

  • Se você fizer logon em uma URL regional herdada, como https://westus.azuredatabricks.net/, o nome da instância será westus.azuredatabricks.net.
  • A ID do workspace aparece na URL somente depois de você ter feito logon usando uma URL regional herdada. Ele aparece após o o=. Na URL https://<databricks-instance>/?o=6280049833385130, a ID do workspace é 6280049833385130.

URL e ID do cluster

Um cluster do Azure Databricks fornece uma plataforma unificada para vários casos de uso, como a execução de pipelines de ETL de produção, análise de streaming, análise ad hoc e aprendizado de máquina. Cada cluster tem uma ID exclusiva chamada ID do cluster. Isso se aplica a clusters para todas as finalidades e de trabalho. Para obter os detalhes de um cluster usando a API REST, a ID do cluster é essencial.

Para obter a ID do cluster, clique na guia Clusters na barra lateral e selecione um nome de cluster. A ID do cluster é o número após o componente /clusters/ na URL desta página

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

Na captura de tela a seguir, a ID do cluster é 0831-211914-clean632.

URL do cluster

URL e ID do painel

Um painel de IA/BI é uma apresentação de visualizações de dados e comentários. Cada painel tem uma ID exclusiva. Você pode usar essa ID para construir links diretos que incluem valores de filtro e parâmetro predefinidos ou acessar o painel usando a API REST.

  • Exemplo de URL do painel:

    https://adb-62800498333851.30.azuredatabricks.net/sql/dashboardsv3/01ef9214fcc7112984a50575bf2b460f

  • Exemplo de ID do painel: 01ef9214fcc7112984a50575bf2b460f

URL e ID do notebook

Um notebook é uma interface baseada na Web para um documento que contém código executável, visualizações e texto de narração. Os notebooks são uma interface para interagir com o Azure Databricks. Cada notebook possui uma ID exclusiva. A URL do notebook tem a ID do notebook, portanto, a URL do notebook é exclusiva para um notebook. Ele pode ser compartilhado com qualquer pessoa na plataforma Azure Databricks com permissão para exibi-lo e editá-lo. Além disso, cada comando de notebook (célula) tem uma URL diferente.

Para localizar uma URL ou ID de notebook, abra um notebook. Para localizar uma URL de célula, clique no conteúdo do comando.

  • URL de notebook de exemplo:

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

  • ID de notebook de exemplo: 1940481404050342.

  • URL de comando de exemplo (célula):

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

ID da pasta

Uma pasta é um diretório usado para armazenar arquivos que podem ser usados no workspace do Azure Databricks. Esses arquivos podem ser notebooks, bibliotecas ou subpastas. Há uma ID específica associada a cada pasta e a cada subpasta individual. A API de Permissões se refere a essa ID como directory_id e ela é usada na configuração e na atualização das permissões de uma pasta.

Para recuperar a directory_id , use a API de Workspace:

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

Este é um exemplo de resposta de chamada à API:

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

ID do modelo

Um modelo refere-se a um modelo registrado do MLflow que permite gerenciar modelos MLflow em produção por meio de transições de fases e controle de versão. A ID do modelo registrado é necessária para alterar as permissões no modelo programaticamente por meio da API de Permissões.

Para obter a ID de um modelo registrado, você pode usar o ponto de extremidade mlflow/databricks/registered-models/get da API do Espaço de trabalho. Por exemplo, o código a seguir retorna o objeto de modelo registrado com suas propriedades, incluindo sua 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

O valor retornado tem o formato:

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

URL e ID do trabalho

Um trabalho é uma forma de executar um notebook ou JAR imediatamente ou de forma programada.

Para obter a URL de um trabalho, clique em Ícone de fluxos de trabalho Fluxos de trabalho na barra lateral e clique em um nome de trabalho. A ID do trabalho está após o texto #job/ na URL. A URL do trabalho é necessária para solucionar a causa raiz da falha nas execuções do trabalho.

Na captura de tela a seguir, a URL do trabalho é:

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

Neste exemplo, a ID do trabalho é 1.

URL do trabalho