Usare le API Lakeview per creare e gestire dashboard

Articolo
05/22/2024

Le API Lakeview offrono strumenti di gestione specifici per la gestione dei dashboard di Lakeview. Questo articolo illustra la creazione di un nuovo dashboard Lakeview da un dashboard legacy esistente. Illustra quindi come usare l'API Lakeview per gestire il dashboard.

Prerequisiti

È necessario un token di accesso personale per connettersi all'area di lavoro. Vedere Autenticazione del token di accesso personale di Azure Databricks.
È necessario l'URL dell'area di lavoro (s) a cui si vuole accedere. Vedere Nomi, URL e ID dell'istanza dell'area di lavoro
Familiarità con le informazioni di riferimento sull'API REST di Databricks.

Eseguire la migrazione di un dashboard

È possibile creare un nuovo dashboard lakeview da un dashboard legacy esistente. L'endpoint del dashboard Migrate nell'API Lakeview richiede .source_dashboard_id Facoltativamente, è possibile includere un nome visualizzato e un percorso in cui archiviare il nuovo dashboard.

Ottenere dashboard SQL di Databricks

Per ottenere source_dashboard_id, usare l'API dashboard SQL di Databricks per ottenere un elenco di tutti i dashboard nell'area di lavoro. Ogni oggetto dashboard nell'elenco results include un UUID che è possibile usare per fare riferimento al dashboard legacy nei servizi API REST di Azure Databricks.

L'esempio seguente mostra una richiesta e una risposta di esempio per l'endpoint Recupera oggetti dashboard. Alcuni dettagli della risposta sono stati omessi per maggiore chiarezza. Per una descrizione completa di questo endpoint e della risposta di esempio, vedere GET /api/2.0/preview/sql/dashboards .

L'UUID per un dashboard legacy è dal id livello superiore dell'elenco di oggetti restituiti in results. Per i dashboard legacy, l'UUID è simile a 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",
      ...
    }
  ]
}

Eseguire la migrazione del dashboard legacy

Usare l'UUID associato al dashboard legacy per creare una copia che viene convertita automaticamente in un nuovo dashboard di Lakeview. Funziona come lo strumento Clone to Lakeview disponibile nell'interfaccia utente. Vedere Clonare un dashboard legacy in un dashboard di Lakeview per informazioni su come eseguire questa operazione usando l'interfaccia utente di Azure Databricks.

L'UUID del dashboard legacy da convertire è necessario nel corpo della richiesta. Facoltativamente, è possibile includere un nuovo display_name valore e un oggetto parent_path che identifica il percorso dell'area di lavoro della cartella in cui si vuole archiviare il dashboard convertito.

La risposta include un dashboard_id, l'UUID per il nuovo dashboard. L'UUID per un dashboard di Lakeview è un valore alfanumerico di 32 cifre, ad esempio 04aab30f99ea444490c10c85852f216c. È possibile usarlo per identificare questo dashboard nello spazio dei nomi Lakeview e in diversi servizi API REST di Azure Databricks.

L'esempio seguente mostra una richiesta e una risposta di esempio. Vedere 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"
}

Ottenere un dashboard bozza

È possibile usare per eseguire il pull dei dettagli del dashboard_id dashboard da una bozza di dashboard. La richiesta e la risposta di esempio seguenti includono i dettagli per la versione corrente del dashboard bozza nell'area di lavoro.

Il etag campo tiene traccia della versione più recente del dashboard. È possibile usarlo per verificare la versione prima di apportare aggiornamenti aggiuntivi.

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"
}

Aggiornare un dashboard

È possibile usare nella dashboard_id risposta precedente per aggiornare il nuovo dashboard lakeview creato con tale operazione. L'esempio seguente mostra una richiesta e una risposta di esempio. L'oggetto dashboard_id dell'esempio precedente viene incluso come parametro path.

e display_namewarehouse_id sono stati modificati. Il dashboard aggiornato ha un nuovo nome e il warehouse predefinito assegnato, come illustrato nella risposta. Il campo etag è facoltativo. Se la versione specificata in etag non corrisponde alla versione corrente, l'aggiornamento viene rifiutato.

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"
}

Creare un dashboard

È possibile usare l'endpoint Crea dashboard nell'API Lakeview per spostare il dashboard tra aree di lavoro. L'esempio seguente include un corpo e una risposta di richiesta di esempio che crea un nuovo dashboard. La serialized_dashboard chiave dell'esempio precedente contiene tutti i dettagli necessari per creare un dashboard bozza duplicato.

L'esempio include un nuovo warehouse_id valore corrispondente a un magazzino nella nuova area di lavoro. Vedere 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"
}

L'unica proprietà obbligatoria nel corpo della richiesta è .display_name Questo strumento può copiare il contenuto del dashboard o creare nuovi dashboard vuoti.

Pubblicare un dashboard

È possibile usare l'endpoint del dashboard Pubblica per pubblicare un dashboard, impostare le credenziali per i visualizzatori ed eseguire l'override del warehouse_id set nel dashboard bozza. È necessario includere l'UUID del dashboard come parametro di percorso.

Il corpo della richiesta imposta la embed_credentials proprietà su false. per impostazione predefinita, la proprietà embed_credentials è impostata su true. Le credenziali di incorporamento consentono agli utenti a livello di account di visualizzare i dati del dashboard. Vedere Pubblicare un dashboard. Viene omesso un nuovo warehouse_id valore, quindi il dashboard pubblicato usa lo stesso warehouse assegnato al dashboard bozza.

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"
}

Ottenere il dashboard pubblicato

La risposta da GET /api/2.0/lakeview/dashboards/{dashboard_id}/published è simile alla risposta fornita nell'esempio precedente. l'oggetto dashboard_id viene incluso come parametro path.

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"
}

Annullare la pubblicazione di un dashboard

Il dashboard bozza viene conservato quando si usa l'API Lakeview per annullare la pubblicazione di un dashboard. Questa richiesta elimina la versione pubblicata del dashboard.

Nell'esempio seguente viene usato l'oggetto dashboard_id dell'esempio precedente. Una richiesta con esito positivo restituisce un 200 codice di stato. Non esiste alcun corpo della risposta.

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

Dashboard cestino

Usare DELETE /api/2.0/lakeview/dashboards/{dashboard_id} per inviare un dashboard bozza al cestino. Il dashboard può comunque essere ripristinato.