Använda instrumentpanels-API:er för att skapa och hantera instrumentpaneler

Artikel
02/04/2025

Databricks REST API innehåller hanteringsverktyg som är specifika för att hantera AI/BI-instrumentpaneler. Den här artikeln visar hur du skapar en ny AI/BI-instrumentpanel från en befintlig äldre instrumentpanel. Sedan visas hur du använder API-verktyg för att hantera instrumentpanelen.

Anteckning

AI/BI-instrumentpaneler kallades tidigare Lakeview-instrumentpaneler. Lakeview-API:et behåller fortfarande det namnet.

Förutsättningar

Konfigurera autentisering för åtkomst till Azure Databricks-resurser. Mer information om autentiseringsalternativ och få installationsinstruktioner finns i Authorizating access to Azure Databricks resources.
Du behöver de url:er för arbetsytan som du vill komma åt. Se Namn på arbetsyteinstanser, URL:er och ID:er.
Kunskaper om Databricks REST API-referens.

Migrera en översiktspanel

Du kan skapa en ny AI/BI-instrumentpanel från en befintlig äldre instrumentpanel. Slutpunkten Migrate-instrumentpanelen i Lakeview-API:et kräver source_dashboard_id. Du kan också inkludera ett visningsnamn och en sökväg där du vill att den nya instrumentpanelen ska lagras.

Hämta äldre instrumentpaneler

För att hämta source_dashboard_id, använd API:et för äldre instrumentpaneler för att få en lista över alla instrumentpaneler i din arbetsyta. Varje instrumentpanelsobjekt i listan results innehåller ett UUID som du kan använda för att referera till den äldre instrumentpanelen i Azure Databricks REST API-tjänster.

I följande exempel visas en begäran och ett svar för Hämta instrumentpanelsobjekt slutpunkt. Vissa svarsinformation har utelämnats för tydlighetens skull. Se GET /api/workspace/dashboards/list för en fullständig beskrivning av den här slutpunkten och exempelsvaret.

UUID för en gammal instrumentpanel är id från översta nivån i listan över objekt som returneras i results. För äldre instrumentpaneler ser UUID ut som 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",
      ...
    }
  ]
}

Migrera gammal instrumentpanel

Använd UUID:n som är associerad med den äldre instrumentpanelen för att skapa en kopia som automatiskt konverteras till en ny AI/BI-instrumentpanel. Detta fungerar som Klona till AI/BI-instrumentpanelen verktyg som är tillgängligt i användargränssnittet. Se Klona en äldre instrumentpanel till en AI/BI-instrumentpanel för att lära dig hur du utför den här åtgärden med hjälp av Azure Databricks-användargränssnittet.

UUID för den äldre instrumentpanelen som du vill konvertera krävs i begärandetexten. Valfritt kan du inkludera ett nytt display_name-värde och ett parent_path-värde som identifierar arbetsytans sökväg till den mapp där du vill lagra den konverterade instrumentpanelen.

Svaret innehåller en dashboard_id, UUID för den nya instrumentpanelen. UUID för en AI/BI-instrumentpanel är ett 32-siffrigt alfanumeriskt värde som 04aab30f99ea444490c10c85852f216c. Du kan använda den för att identifiera den här instrumentpanelen i Lakeview-namnområdet och mellan olika Azure Databricks REST API-tjänster.

I följande exempel visas en exempelbegäran och ett svar. Se 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"
}

Hämta ett utkast till instrumentpanel

Du kan använda dashboard_id för att hämta instrumentpanelsinformation från ett utkast till instrumentpanel. Följande exempelbegäran och svar innehåller detaljer för den nuvarande utkastversionen av instrumentpanelen i arbetsytan.

Fältet etag spårar den senaste versionen av instrumentpanelen. Du kan använda detta för att verifiera versionen innan du gör ytterligare uppdateringar.

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

Uppdatera en instrumentpanel

Du kan använda dashboard_id i föregående svar för att uppdatera den nya AI/BI-instrumentpanelen som skapades med den åtgärden. I följande exempel visas en exempelbegäran och ett svar. dashboard_id från föregående exempel ingår som en sökvägsparameter.

display_name och warehouse_id har ändrats. Den uppdaterade instrumentpanelen har ett nytt namn och tilldelat standardlager, enligt svaret. Fältet etag är valfritt. Om den version som anges i etag inte matchar den aktuella versionen avvisas uppdateringen.

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

Skapa en instrumentpanel

Du kan använda slutpunkten Skapa instrumentpanel i Lakeview-API:et för att flytta instrumentpaneler mellan arbetsytor. I följande exempel ingår ett exempel på begärandetext och svar som skapar en ny instrumentpanel. Den serialized_dashboard nyckeln från föregående exempel innehåller all nödvändig information för att skapa en duplicerad utkastinstrumentpanel.

Exemplet innehåller ett nytt warehouse_id värde som motsvarar ett lager i den nya arbetsytan. Se 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"
}

Den enda obligatoriska egenskapen i begärandetexten är en display_name. Det här verktyget kan kopiera instrumentpanelsinnehåll eller skapa nya, tomma instrumentpaneler.

Publicera en instrumentpanel

Du kan använda Publicera instrumentpanel slutpunkt för att publicera en instrumentpanel, ange autentiseringsuppgifter för visning och åsidosätta warehouse_id som angetts i utkastinstrumentpanelen. Du måste inkludera instrumentpanelens UUID som en sökvägsparameter.

Begärandetexten anger egenskapen embed_credentials till false. Som standard är embed_credentials inställt på true. Genom att bädda in autentiseringsuppgifter kan användare på kontonivå visa instrumentpanelsdata. Visa Publicera en instrumentpanel. Ett nytt warehouse_id-värde utelämnas, så den publicerade instrumentpanelen använder samma lager som tilldelats utkastinstrumentpanelen.

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

Kom åt publicerad kontrollpanel

Svaret från GET /api/2.0/lakeview/dashboards/{dashboard_id}/published liknar svaret i föregående exempel. dashboard_id ingår som en sökvägsparameter.

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

Avpublicera en instrumentpanel

Instrumentpanelens utkast behålls när du använder Lakeview-API:et för att ta bort publiceringen av en instrumentpanel. Den här begäran tar bort den publicerade versionen av instrumentpanelen.

I följande exempel används dashboard_id från föregående exempel. En lyckad begäran ger en 200 statuskod. Det finns ingen svarskropp.

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

Papperskorgens instrumentpanel

Använd DELETE /api/2.0/lakeview/dashboards/{dashboard_id} för att skicka ett utkast till instrumentpanelen till papperskorgen. Instrumentpanelen kan fortfarande återställas.