Dashboard-API's gebruiken om dashboards te maken en te beheren

Artikel
02/04/2025

De Databricks REST API bevat beheerhulpprogramma's die specifiek zijn bedoeld voor het beheren van AI/BI-dashboards. In dit artikel ziet u hoe u een nieuw AI/BI-dashboard maakt op basis van een bestaand verouderd dashboard. Vervolgens ziet u hoe u API-hulpprogramma's gebruikt om het dashboard te beheren.

Notitie

AI-/BI-dashboards werden voorheen Lakeview-dashboards genoemd. De Lakeview-API behoudt die naam nog steeds.

Voorwaarden

Verificatie instellen voor toegang tot Azure Databricks-resources. Zie Toegang tot Azure Databricks-resources autoriserenvoor meer informatie over verificatieopties en installatie-instructies.
U hebt de URL('s) van de werkruimte nodig waartoe u toegang wilt hebben. Zie namen, URL's en id's van werkruimte-exemplaren.
Bekendheid met de Databricks REST API-verwijzing.

Een dashboard migreren

U kunt een nieuw AI/BI-dashboard maken op basis van een bestaand verouderd dashboard. Het Migrate-dashboard-eindpunt in de Lakeview-API vereist het source_dashboard_id. U kunt eventueel een weergavenaam en een pad opnemen waar u het nieuwe dashboard wilt opslaan.

Oude dashboards verkrijgen

Als u de source_dashboard_idwilt ophalen, gebruikt u de verouderde dashboards API om een lijst op te halen met alle dashboards in uw werkruimte. Elk dashboardobject in de lijst results bevat een UUID die u kunt gebruiken om te verwijzen naar het verouderde dashboard in Azure Databricks REST API-services.

In het volgende voorbeeld ziet u een voorbeeldaanvraag en antwoord voor de Get dashboard-objecten endpoint. Sommige antwoorddetails zijn voor duidelijkheid weggelaten. Zie GET /api/workspace/dashboards/list voor een volledige beschrijving van dit eindpunt en voorbeeldantwoord.

De UUID voor een verouderd dashboard is de id op het hoogste niveau van de lijst met objecten die worden geretourneerd in results. Voor verouderde dashboards ziet de UUID eruit als 4e443c27-9f61-4f2e-a12d-ea5668460bf1.

GET /api/workspace/dashboards/list

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",
      ...
    }
  ]
}

Het verouderde dashboard migreren

Gebruik de UUID die is gekoppeld aan het verouderde dashboard om een kopie te maken die automatisch wordt geconverteerd naar een nieuw AI/BI-dashboard. Dit werkt als het klonen naar AI/BI-dashboard hulpprogramma dat beschikbaar is in de gebruikersinterface. Zie Een verouderd dashboard klonen naar een AI/BI-dashboard voor meer informatie over het uitvoeren van deze bewerking met behulp van de Gebruikersinterface van Azure Databricks.

De UUID van het verouderde dashboard dat u wilt converteren, is vereist in de hoofdtekst van de aanvraag. U kunt desgewenst een nieuwe display_name-waarde en een parent_path opnemen waarmee het werkruimtepad wordt geïdentificeerd van de map waarin u het geconverteerde dashboard wilt opslaan.

Het antwoord bevat een dashboard_id, de UUID voor het nieuwe dashboard. De UUID voor een AI/BI-dashboard is een alfanumerieke waarde van 32 cijfers, zoals 04aab30f99ea444490c10c85852f216c. U kunt dit dashboard gebruiken om dit dashboard te identificeren in de Lakeview-naamruimte en in verschillende Azure Databricks REST API-services.

In het volgende voorbeeld ziet u een voorbeeld van een aanvraag en antwoord. Zie 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"
}

Een conceptdashboard verkrijgen

U kunt de dashboard_id gebruiken om dashboardgegevens op te halen uit een conceptdashboard. De volgende voorbeeldaanvraag en het volgende antwoord bevatten details voor de huidige versie van het conceptdashboard in de werkruimte.

In het veld etag wordt de nieuwste versie van het dashboard bijgehouden. U kunt deze gebruiken om de versie te controleren voordat u aanvullende updates aanbrengt.

GET /api/workspace/dashboards/list/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"
}

Een dashboard bijwerken

U kunt de dashboard_id in het vorige antwoord gebruiken om het nieuwe AI/BI-dashboard dat met die bewerking is gemaakt, bij te werken. In het volgende voorbeeld ziet u een voorbeeld van een aanvraag en antwoord. De dashboard_id uit het vorige voorbeeld is opgenomen als padparameter.

De display_name en warehouse_id zijn gewijzigd. Het bijgewerkte dashboard heeft een nieuwe naam en een toegewezen standaardwarehouse, zoals wordt weergegeven in het antwoord. Het etag veld is optioneel. Als de versie die is opgegeven in de etag niet overeenkomt met de huidige versie, wordt de update geweigerd.

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

Een dashboard maken

U kunt het Create-dashboard-eindpunt in de Lakeview-API gebruiken om uw dashboard tussen werkruimtes te verplaatsen. Het volgende voorbeeld bevat een voorbeeld van de aanvraagtekst en het antwoord waarmee een nieuw dashboard wordt gemaakt. De serialized_dashboard sleutel uit het vorige voorbeeld bevat alle benodigde details om een dubbel conceptdashboard te maken.

Het voorbeeld bevat een nieuwe warehouse_id waarde die overeenkomt met een magazijn in de nieuwe werkruimte. Zie 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"
}

De enige vereiste eigenschap in de aanvraagtekst is een display_name. Met dit hulpprogramma kunt u dashboardinhoud kopiëren of nieuwe, lege dashboards maken.

Een dashboard publiceren

U kunt het Publish dashboard eindpunt gebruiken om een dashboard te publiceren, inloggegevens in te stellen voor kijkers en de instelling warehouse_id in het conceptdashboard te overschrijven. U moet de UUID van het dashboard opnemen als padparameter.

De hoofdtekst van de aanvraag stelt de eigenschap embed_credentials in op false. Standaard is embed_credentials ingesteld op true. Door referenties in te sluiten, kunnen gebruikers op accountniveau dashboardgegevens bekijken. Zie Een dashboard publiceren. Er wordt een nieuwe warehouse_id waarde weggelaten, dus het gepubliceerde dashboard maakt gebruik van hetzelfde magazijn dat is toegewezen aan het conceptdashboard.

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

Gepubliceerd dashboard ophalen

Het antwoord van GET /api/2.0/lakeview/dashboards/{dashboard_id}/gepubliceerde is vergelijkbaar met het antwoord in het vorige voorbeeld. De dashboard_id is opgenomen als padparameter.

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

Publicatie van een dashboard ongedaan maken

Het conceptdashboard blijft behouden wanneer u de Lakeview-API gebruikt om de publicatie van een dashboard ongedaan te maken. Met deze aanvraag wordt de gepubliceerde versie van het dashboard verwijderd.

In het volgende voorbeeld wordt de dashboard_id uit het vorige voorbeeld gebruikt. Een geslaagde aanvraag levert een 200 statuscode op. Er is geen antwoordtekst.

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

Prullenbakoverzicht

Gebruik DELETE /api/2.0/lakeview/dashboards/{dashboard_id} om een conceptdashboard naar de prullenbak te verzenden. Het dashboard kan nog steeds worden hersteld.