Vytváření a správa řídicích panelů pomocí rozhraní API Lakeview

Článek
07/20/2024

Rozhraní API Lakeview poskytují nástroje pro správu speciálně pro správu řídicích panelů AI/BI. Tento článek ukazuje, jak vytvořit nový řídicí panel AI/BI z existujícího staršího řídicího panelu. Pak ukazuje, jak pomocí rozhraní API Lakeview spravovat řídicí panel.

Požadavky

Pro připojení k pracovnímu prostoru potřebujete osobní přístupový token. Viz ověřování tokenů pat azure Databricks.
Potřebujete adresu URL pracovního prostoru, ke které chcete získat přístup. Zobrazení názvů, adres URL a ID instancí pracovního prostoru
Znalost referenčních informací k rozhraní REST API služby Databricks

Migrace řídicího panelu

Nový řídicí panel AI/BI můžete vytvořit z existujícího staršího řídicího panelu. Koncový bod řídicího panelu Migrovat v rozhraní API Lakeview vyžaduje rozhraní source_dashboard_id. Volitelně můžete zahrnout zobrazovaný název a cestu, kam chcete nový řídicí panel uložit.

Získání řídicích panelů SQL databricks

Pokud chcete získat rozhraní source_dashboard_idAPI řídicích panelů SQL Databricks, získejte seznam všech řídicích panelů ve vašem pracovním prostoru. Každý objekt řídicího panelu results v seznamu obsahuje UUID, který můžete použít k odkazování na starší řídicí panel napříč službami rozhraní REST API Služby Azure Databricks.

Následující příklad ukazuje ukázkový požadavek a odpověď pro koncový bod Získat objekty řídicího panelu. Kvůli přehlednosti byly vynechány některé podrobnosti odpovědi. Úplný popis tohoto koncového bodu a ukázkové odpovědi najdete v tématu GET /api/2.0/preview/sql/dashboards .

UUID staršího řídicího panelu je id z nejvyšší úrovně seznamu objektů vrácených v results. U starších řídicích panelů vypadá UUID jako 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",
      ...
    }
  ]
}

Migrace staršího řídicího panelu

Pomocí UUID přidruženého ke staršímu řídicímu panelu vytvořte kopii, která se automaticky převede na nový řídicí panel AI/BI. To funguje podobně jako nástroj Clone to Lakeview dostupný v uživatelském rozhraní. Informace o provedení této operace pomocí uživatelského rozhraní Azure Databricks najdete v tématu Klonování staršího řídicího panelu na řídicím panelu Lakeview.

Identifikátor UUID staršího řídicího panelu, který chcete převést, se vyžaduje v textu požadavku. Volitelně můžete zahrnout novou display_name hodnotu a hodnotu parent_path , která identifikuje cestu pracovního prostoru složky, do které chcete převést řídicí panel uložit.

Odpověď obsahuje dashboard_ididentifikátor UUID nového řídicího panelu. UUID pro řídicí panel AI/BI je 32místná alfanumerická hodnota jako 04aab30f99ea444490c10c85852f216c. Můžete ho použít k identifikaci tohoto řídicího panelu v oboru názvů Lakeview a napříč různými službami rozhraní REST API Služby Azure Databricks.

Následující příklad ukazuje ukázkový požadavek a odpověď. Viz 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"
}

Získání řídicího panelu konceptu

Podrobnosti řídicího panelu dashboard_id můžete načíst z řídicího panelu konceptu. Následující ukázkový požadavek a odpověď obsahují podrobnosti o aktuální verzi řídicího panelu konceptu v pracovním prostoru.

Pole etag sleduje nejnovější verzi řídicího panelu. Tuto možnost můžete použít k ověření verze před provedením dalších aktualizací.

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

Aktualizace řídicího panelu

Pomocí předchozí odpovědi můžete dashboard_id aktualizovat nový řídicí panel AI/BI vytvořený touto operací. Následující příklad ukazuje ukázkový požadavek a odpověď. Z dashboard_id předchozího příkladu je zahrnutý jako parametr cesty.

warehouse_id A display_name byly změněny. Aktualizovaný řídicí panel má nový název a přiřazený výchozí sklad, jak je znázorněno v odpovědi. Pole etag je nepovinné. Pokud verze zadaná v aktuální etag verzi neodpovídá aktuální verzi, aktualizace se odmítne.

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

Vytvoření řídicího panelu

K přesunutí řídicího panelu mezi pracovními prostory můžete použít koncový bod Vytvořit řídicí panel v rozhraní API Lakeview. Následující příklad obsahuje ukázkový text požadavku a odpověď, která vytvoří nový řídicí panel. Klíč serialized_dashboard z předchozího příkladu obsahuje všechny potřebné podrobnosti k vytvoření duplicitního řídicího panelu konceptu.

Ukázka obsahuje novou warehouse_id hodnotu odpovídající skladu v novém pracovním prostoru. Viz 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"
}

Jediná požadovaná vlastnost v textu požadavku je display_name. Tento nástroj může kopírovat obsah řídicího panelu nebo vytvářet nové prázdné řídicí panely.

Publikování řídicího panelu

Koncový bod publikovat řídicí panel můžete použít k publikování řídicího panelu , nastavení přihlašovacích údajů pro čtenáře a přepsání warehouse_id sady v řídicím panelu konceptu. Jako parametr cesty musíte zahrnout UUID řídicího panelu.

Text požadavku nastaví embed_credentials vlastnost na false. Ve výchozím nastavení embed_credentials je nastavená hodnota true. Vkládání přihlašovacích údajů umožňuje uživatelům na úrovni účtu zobrazit data řídicího panelu. Viz Publikování řídicího panelu. Vynechá se nová warehouse_id hodnota, takže publikovaný řídicí panel používá stejný sklad přiřazený k řídicímu panelu konceptu.

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

Získání publikovaného řídicího panelu

Odpověď z get /api/2.0/lakeview/dashboards/{dashboard_id}/published je podobná odpovědi poskytnuté v předchozím příkladu. Tento dashboard_id parametr je součástí parametru cesty.

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

Zrušení publikování řídicího panelu

Koncept řídicího panelu se zachová, když k zrušení publikování řídicího panelu použijete rozhraní API Lakeview. Tento požadavek odstraní publikovanou verzi řídicího panelu.

Následující příklad používá z předchozího příkladu dashboard_id . Úspěšný požadavek poskytuje stavový 200 kód. Neexistuje žádný text odpovědi.

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

Řídicí panel koše

Pomocí příkazu DELETE /api/2.0/lakeview/dashboards/{dashboard_id} odešlete koncept řídicího panelu do koše. Řídicí panel je možné obnovit.