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

Databricks REST API innehåller hanteringsverktyg som är specifika för att hantera AI/BI-instrumentpaneler. Den här sidan visar hur du använder API-verktyg för att skapa och hantera instrumentpaneler. För att utföra dessa uppgifter via användargränssnittet, se Författarpaneler.

Anteckning

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

Förutsättningar

Konfigurera autentisering för att komma åt Azure Databricks resurser. Mer information om autentiseringsalternativ och installationsinstruktioner finns i Auktorisera åtkomst till Azure Databricks resurser.
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.

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

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 ett utkast av instrumentpanel.

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

Publicera en instrumentpanel med autentiseringsuppgifter för tjänsthuvud

Du kan publicera en instrumentpanel med autentiseringsuppgifter för tjänstehuvudman inbäddade genom att autentisera som tjänstehuvudman när du gör API-anropet. När du publicerar med hjälp av en token för tjänstens huvudnamn publiceras instrumentpanelen med tjänstens huvudnamns data- och beräkningsbehörigheter, så att användare utan direkt dataåtkomst kan visa instrumentpanelen.

Innan publiceringen måste service principal ha minst CAN MANAGE-behörigheter på instrumentpanelen, SELECT-behörigheter för alla datakällor som används i instrumentpanelen och CAN USE-behörigheter på datalagret. Mer information om hur du skapar tjänstens huvudnamn och genererar OAuth-hemligheter finns i Service principals och Authorize service principal access to Azure Databricks with OAuth.

Autentisera först som service principal för att hämta en åtkomsttoken.

POST https://<databricks-instance>/oidc/v1/token

Request body (form-urlencoded):

grant_type=client_credentials&scope=all-apis

Authorization header:

Basic <base64-encoded-client-id:client-secret>

Response:

{
  "access_token": "eyJraWQiOiJkYTA4ZTVjZ...",
  "token_type": "Bearer",
  "expires_in": 3600
}

Använd sedan åtkomsttoken för att publicera instrumentpanelen med tjänstens huvudnamns autentiseringsuppgifter:

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

Authorization header:

Bearer <service-principal-access-token>

Request body:

{
  "embed_credentials": true,
  "warehouse_id": "5e2f98ab3476cfd0"
}

Response:

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

När embed_credentials är inställt på trueanvänder instrumentpanelens visningsprogram tjänstens huvudnamns behörigheter för att komma åt data och beräkningsresurser. Användarna behöver bara behörighet att komma åt själva instrumentpanelsobjektet. Alla instrumentpanelsfrågor körs med tjänstens huvudnamns identitet, så granskningsloggarna visar tjänstens huvudnamn som frågeexekutor.

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

Ta bort publiceringen av 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

Skräppostpanel

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.