Use as APIs do Lakeview para criar e gerenciar painéis

Artigo
07/20/2024

As APIs do Lakeview fornecem ferramentas de gerenciamento especificamente para gerenciar painéis de IA/BI. Este artigo demonstra como criar um novo painel de IA/BI a partir de um painel herdado existente. Em seguida, ele mostra como usar a API Lakeview para gerenciar o painel.

Pré-requisitos

Você precisa de um token de acesso pessoal para se conectar ao seu espaço de trabalho. Consulte Autenticação de token de acesso pessoal do Azure Databricks.
Você precisa da(s) URL(s) do espaço de trabalho que deseja acessar. Consulte Nomes de instâncias, URLs e IDs do espaço de trabalho
Familiaridade com a referência da API REST do Databricks.

Migrar um painel

Você pode criar um novo painel de IA/BI a partir de um painel herdado existente. O ponto de extremidade do painel Migrate na API Lakeview requer o source_dashboard_id. Opcionalmente, você pode incluir um nome para exibição e um caminho onde deseja que o novo painel seja armazenado.

Obter painéis SQL do Databricks

Para obter o source_dashboard_id, use a API de painéis SQL do Databricks para obter uma lista de todos os painéis em seu espaço de trabalho. Cada objeto de painel na results lista inclui um UUID que você pode usar para fazer referência ao painel herdado nos serviços de API REST do Azure Databricks.

O exemplo a seguir mostra um exemplo de solicitação e resposta para o ponto de extremidade de objetos Get dashboard. Alguns detalhes da resposta foram omitidos para maior clareza. Consulte GET /api/2.0/preview/sql/dashboards para obter uma descrição completa deste ponto de extremidade e exemplo de resposta.

O UUID de um painel herdado é o id nível superior da lista de objetos retornados em results. Para painéis herdados, o UUID se parece com 4e443c27-9f61-4f2e-a12d-ea5668460bf1.

GET /api/2.0/preview/sql/dashboards

Query Parameters:

{
"page_size": <optional>,
"page": <optional>,
"order": <optional>
"q": <optional>
}

Response:

{
  "count": 1,
  "page": 1,
  "page_size": 25,
  "results": [
    {
      "id": "4e443c27-9f61-4f2e-a12d-ea5668460bf1",
      "slug": "sales-dashboard",
      "parent": "folders/2025532471912059",
      ...
    }
  ]
}

Migrar painel herdado

Use o UUID associado ao painel herdado para criar uma cópia que é convertida automaticamente em um novo painel de IA/BI. Isso funciona como a ferramenta Clone to Lakeview disponível na interface do usuário. Consulte Clonar um painel herdado em um painel do Lakeview para saber como executar essa operação usando a interface do usuário do Azure Databricks.

O UUID do painel herdado que você deseja converter é necessário no corpo da solicitação. Opcionalmente, você pode incluir um novo display_name valor e um parent_path que identifique o caminho do espaço de trabalho da pasta onde você deseja que o painel convertido seja armazenado.

A resposta inclui um dashboard_id, o UUID para o novo painel. O UUID para um painel de IA/BI é um valor alfanumérico de 32 dígitos como 04aab30f99ea444490c10c85852f216c. Você pode usá-lo para identificar esse painel no namespace Lakeview e em diferentes serviços de API REST do Azure Databricks.

O exemplo a seguir mostra um exemplo de solicitação e resposta. Consulte POST /api/2.0/lakeview/dashboards/migrate.

POST /api/2.0/lakeview/dashboards/migrate

Request body parameters:
{
  "source_dashboard_id": "4e443c27-9f61-4f2e-a12d-ea5668460bf1",
  "display_name": "Monthly Traffic Report",
  "parent_path": "/path/to/dir"
}

Response:
{
  "dashboard_id": "04aab30f99ea444490c10c85852f216c",
  "display_name": "Monthly Traffic Report",
  "path": "/path/to/dir/Monthly Traffic Report.lvdash.json",
  "create_time": "2019-08-24T14:15:22Z",
  "update_time": "2019-08-24T14:15:22Z",
  "warehouse_id": "47bb1c472649e711",
  "etag": "80611980",
  "serialized_dashboard": "{\"pages\":[{\"name\":\"b532570b\",\"displayName\":\"New Page\"}]}",
  "lifecycle_state": "ACTIVE",
  "parent_path": "/path/to/dir"
}

Obter um painel de rascunho

Você pode usar o dashboard_id para extrair detalhes do painel a partir de um painel de rascunho. O exemplo de solicitação e resposta a seguir inclui detalhes para a versão atual do painel de rascunho no espaço de trabalho.

O etag campo rastreia a versão mais recente do painel. Você pode usar isso para verificar a versão antes de fazer atualizações adicionais.

GET /api/2.0/lakeview/dashboards/04aab30f99ea444490c10c85852f216c

Response:

{
  "dashboard_id": "04aab30f99ea444490c10c85852f216c",
  "display_name": "Monthly Traffic Report",
  "path": "/path/to/dir/Monthly Traffic Report.lvdash.json",
  "create_time": "2019-08-24T14:15:22Z",
  "update_time": "2019-08-24T14:15:22Z",
  "warehouse_id": "47bb1c472649e711",
  "etag": "80611980",
  "serialized_dashboard": "{\"pages\":[{\"name\":\"b532570b\",\"displayName\":\"New Page\"}]}",
  "lifecycle_state": "ACTIVE",
  "parent_path": "/path/to/dir"
}

Atualizar um painel

Você pode usar o dashboard_id na resposta anterior para atualizar o novo painel de IA/BI criado com essa operação. O exemplo a seguir mostra um exemplo de solicitação e resposta. O dashboard_id do exemplo anterior é incluído como um parâmetro path.

O display_name e warehouse_id foram alterados. O painel atualizado tem um novo nome e um depósito padrão atribuído, conforme mostrado na resposta. O campo etag é opcional. Se a versão especificada no etag não corresponder à versão atual, a atualização será rejeitada.

PATCH /api/2.0/lakeview/dashboards/04aab30f99ea444490c10c85852f216c

Request body:

{
  "display_name": "Monthly Traffic Report 2",
  "warehouse_id": "c03a4f8a7162bc9f",
  "etag": "80611980"
}

Response:

{
  "dashboard_id": "04aab30f99ea444490c10c85852f216c",
  "display_name": "Monthly Traffic Report 2",
  "path": "/path/to/dir/Monthly Traffic Report 2.lvdash.json",
  "create_time": "2019-08-24T14:15:22Z",
  "update_time": "2019-08-24T14:15:22Z",
  "warehouse_id": "c03a4f8a7162bc9f",
  "etag": "80611981",
  "serialized_dashboard": "{\"pages\":[{\"name\":\"b532570b\",\"displayName\":\"New Page\"}]}",
  "lifecycle_state": "ACTIVE",
  "parent_path": "/path/to/dir"
}

Criar um dashboard

Você pode usar o ponto de extremidade Criar painel na API Lakeview para mover seu painel entre espaços de trabalho. O exemplo a seguir inclui um corpo de solicitação de exemplo e uma resposta que cria um novo painel. A serialized_dashboard chave do exemplo anterior contém todos os detalhes necessários para criar um painel de rascunho duplicado.

O exemplo inclui um novo warehouse_id valor correspondente a um depósito no novo espaço de trabalho. Consulte POST /api/2.0/lakeview/dashboards.

POST /api/2.0/lakeview/dashboards

Request body:

{
  "display_name": "Monthly Traffic Report 2",
  "warehouse_id": "5e2f98ab3476cfd0",
  "serialized_dashboard": "{\"pages\":[{\"name\":\"b532570b\",\"displayName\":\"New Page\"}]}",
  "parent_path": "/path/to/dir"
}

Response:

{
  "dashboard_id": "1e23fd84b6ac7894e2b053907dca9b2f",
  "display_name": "Monthly Traffic Report 2",
  "path": "/path/to/dir/Monthly Traffic Report 2.lvdash.json",
  "create_time": "2019-08-24T14:15:22Z",
  "update_time": "2019-08-24T14:15:22Z",
  "warehouse_id": "5e2f98ab3476cfd0",
  "etag": "14350695",
  "serialized_dashboard": "{\"pages\":[{\"name\":\"b532570b\",\"displayName\":\"New Page\"}]}",
  "lifecycle_state": "ACTIVE",
  "parent_path": "/path/to/dir"
}

A única propriedade necessária no corpo da solicitação é um display_namearquivo . Essa ferramenta pode copiar o conteúdo do painel ou criar novos painéis em branco.

Publicar um painel

Você pode usar o ponto de extremidade Publicar painel para publicar um painel, definir credenciais para visualizadores e substituir o warehouse_id conjunto no painel de rascunho. Você deve incluir o UUID do painel como um parâmetro de caminho.

O corpo da solicitação define a embed_credentials propriedade como false. Por padrão, embed_credentials é definido como true. A incorporação de credenciais permite que os usuários no nível da conta visualizem os dados do painel. Consulte Publicar um painel. Um novo warehouse_id valor é omitido, portanto, o painel publicado usa o mesmo depósito atribuído ao painel de rascunho.

POST /api/2.0/lakeview/dashboards/1e23fd84b6ac7894e2b053907dca9b2f/published

Request body:

{
  "embed_credentials": false
}

Response:

{
  "display_name": "Monthly Traffic Report 2",
  "warehouse_id": "5e2f98ab3476cfd0",
  "embed_credentials": false,
  "revision_create_time": "2019-08-24T14:15:22Z"
}

Obter painel publicado

A resposta de GET /api/2.0/lakeview/dashboards/{dashboard_id}/published é semelhante à resposta fornecida no exemplo anterior. O dashboard_id está incluído como um parâmetro de caminho.

GET /api/2.0/lakeview/dashboards/1e23fd84b6ac7894e2b053907dca9b2f/published

Response:

{
  "display_name": "Monthly Traffic Report 2",
  "warehouse_id": "5e2f98ab3476cfd0",
  "embed_credentials": false,
  "revision_create_time": "2019-08-24T14:15:22Z"
}

Cancelar a publicação de um painel

O painel de rascunho é mantido quando você usa a API do Lakeview para cancelar a publicação de um painel. Essa solicitação exclui a versão publicada do painel.

O exemplo a seguir usa o dashboard_id do exemplo anterior. Uma solicitação bem-sucedida produz um 200 código de status. Não existe um organismo de resposta.

DELETE /api/2.0/lakeview/dashboards/1e23fd84b6ac7894e2b053907dca9b2f/published

Painel da Lixeira

Use DELETE /api/2.0/lakeview/dashboards/{dashboard_id} para enviar um painel de rascunho para a lixeira. O painel ainda pode ser recuperado.