Oktatóanyag: Irányítópultok kezelése Munkaterület API-kkal

Cikk
04/27/2024

Ez az oktatóanyag bemutatja, hogyan kezelheti az irányítópultokat a Lakeview API és a Workspace API használatával. Minden lépés tartalmaz egy mintakérést és választ, valamint magyarázatokat az API-eszközök és tulajdonságok együttes használatáról. Minden lépésre önállóan hivatkozhat. Az összes lépés végrehajtása végigvezeti a teljes munkafolyamaton.

Feljegyzés

Ez a munkafolyamat meghívja a Workspace API-t egy Lakeview-irányítópult általános munkaterület-objektumként való lekéréséhez.

Előfeltételek

A munkaterülethez való csatlakozáshoz személyes hozzáférési jogkivonatra van szüksége. Tekintse meg az Azure Databricks személyes hozzáférési jogkivonatának hitelesítését.
Szüksége van a elérni kívánt munkaterület munkaterület-azonosítójára. Lásd: Munkaterület-példányok nevei, URL-címei és azonosítói
A Databricks REST API-referencia ismerete.

1. lépés: Munkaterület könyvtárának felfedezése

A Munkaterületlista API GET /api/2.0/workspace/list segítségével megismerheti a munkaterület címtárstruktúráját. Lekérheti például az aktuális munkaterület összes fájljának és könyvtárának listáját.

Az alábbi példában a path kérés tulajdonsága egy felhasználó kezdőlapján tárolt mappára examples_folder mutat. A felhasználónév az elérési úton van megadva. first.last@example.com

A válasz azt mutatja, hogy a mappa egy szövegfájlt, egy könyvtárat és egy Lakeview-irányítópultot tartalmaz.

GET /api/2.0/workspace/list

Query Parameters:
{
"path": "/Users/first.last@example.com/examples_folder"
}

Response:
{
  "objects": [
    {
      "object_type": "FILE",
      "path": "/Users/first.last@example.com/examples_folder/myfile.txt",
      "created_at": 1706822278103,
      "modified_at": 1706822278103,
      "object_id": 3976707922053539,
      "resource_id": "3976707922053539"
  },
  {
      "object_type": "DIRECTORY",
      "path": "/Users/first.last@example.com/examples_folder/another_folder",
      "object_id": 2514959868792596,
      "resource_id": "2514959868792596"
  },
  {
      "object_type": "DASHBOARD",
      "path": "/Users/first.last@example.com/examples_folder/mydashboard.lvdash.json",
      "object_id": 7944020886653361,
      "resource_id": "01eec14769f616949d7a44244a53ed10"
    }
  ]
}

2. lépés: Irányítópult exportálása

A Munkaterület exportálása API GET /api/2.0/workspace/export lehetővé teszi az irányítópult tartalmának fájlként való exportálását. A Lakeview-irányítópult fájljai az irányítópult piszkozatverzióját tükrözik. Az alábbi példákban szereplő válasz egy minimális irányítópult-definíció tartalmát mutatja be. A szerializálás további részleteinek megismeréséhez és megértéséhez próbáljon meg exportálni néhány saját irányítópultot.

Az exportált fájl letöltése

Az alábbi példa bemutatja, hogyan tölthet le egy irányítópultfájlt az API használatával.

A "path" példában szereplő tulajdonság egy Lakeview-irányítópult fájltípus-kiterjesztéssel lvdash.jsonvégződik. A fájlnév a munkaterületen látható módon megelőzi a bővítményt. Ebben az esetben az mydashboard.

Emellett a "direct_download" kérés tulajdonsága úgy van beállítva, hogy true a válasz maga az exportált fájl legyen.

Feljegyzés

A "displayName" válasz Lap tulajdonságában látható tulajdonság nem tükrözi a munkaterület irányítópultjának látható nevét.

GET /api/2.0/workspace/export

Query parameters:
{
  "path": "/Users/first.last@example.com/examples_folder/mydashboard.lvdash.json",
  "direct_download": true
}

Response:
{
  "pages": [
    {
      "name": "880de22a",
      "displayName": "New Page"
    }
  ]
}

Az exportált fájl kódolása

Az alábbi kód egy példaválaszt jelenít meg, amelyben "direct_download" a tulajdonság értéke hamis. A válasz a tartalmat base64 kódolású sztringként tartalmazza.

GET /api/2.0/workspace/export

Query parameters:
{
    "path": "/Users/first.last@example.com/examples_folder/mydashboard.lvdash.json",
    "direct_download": false
}

Response:
{
    "content": "IORd/DYYsCNElspwM9XBZS/i5Z9dYgW5SkLpKJs48dR5p5KkIW8OmEHU8lx6CZotiCDS9hkppQG=",
    "file_type": "lvdash.json"
}

3. lépés: Irányítópult importálása

A Munkaterület importálása API POST /api/2.0/workspace/import használatával vázlat irányítópultokat importálhat egy munkaterületre. Például miután exportált egy kódolt fájlt, az előző példához hasonlóan importálhatja az irányítópultot egy új munkaterületre.

Ahhoz, hogy az importálást Lakeview-irányítópultként lehessen felismerni, két paramétert kell megadni:

"format": "AUTO" – ez a beállítás lehetővé teszi, hogy a rendszer automatikusan észlelje az eszköz típusát.
- "path": tartalmaznia kell egy ".lvdash.json" végződésű fájl elérési útját.

Fontos

Ha ezek a beállítások nincsenek megfelelően konfigurálva, az importálás sikeres lehet, de az irányítópult normál fájlként lesz kezelve.

Az alábbi példa egy megfelelően konfigurált importálási kérelmet mutat be.


POST /api/2.0/workspace/import

Request body parameters:
{
        "path": "/Users/first.last@example.com/examples_folder/myseconddashboard.lvdash.json",
        "content": "IORd/DYYsCNElspwM9XBZS/i5Z9dYgW5SkLpKJs48dR5p5KkIW8OmEHU8lx6CZotiCDS9hkppQG=",
        "format": "AUTO"
}

Response:
{}

4. lépés: Felülírás importáláskor (nem kötelező)

Ha megkísérli újból kiadni ugyanazt az API-kérést, a következő hibaüzenet jelenik meg:

{
        "error_code": "RESOURCE_ALREADY_EXISTS",
        "message": "Path (/Users/first.last@example.com/examples_folder/myseconddashboard.lvdash.json) already exists."
}

Ha inkább felülírni szeretné az ismétlődő kérést, állítsa a "overwrite" tulajdonságot true az alábbi példához hasonlóan.


POST /api/2.0/workspace/import

Request body parameters:
{
        "path": /Users/first.last@example.com/examples_folder/myseconddashboard.lvdash.json",
        "content": "IORd/DYYsCNElspwM9XBZS/i5Z9dYgW5SkLpKJs48dR5p5KkIW8OmEHU8lx6CZotiCDS9hkppQG=",
        "format": "AUTO",
        "overwrite": true
}

Response:
{}

5. lépés: Metaadatok lekérése

Bármilyen munkaterületi objektum metaadatait lekérheti, beleértve egy Lakeview-irányítópultot is. Lásd: GET /api/2.0/workspace/get-status.

Az alábbi példában az get-status előző példából származó importált irányítópultra vonatkozó kérés látható. A válasz tartalmazza azokat a részleteket, amelyek megerősítik, hogy a fájl importálása sikeresen megtörtént "DASHBOARD". Emellett egy "resource_id" tulajdonságból áll, amelyet a Lakeview API-val azonosítóként használhat.

GET /api/2.0/workspace/get-status

Query parameters:
{
        "path": "/Users/first.last@example.com/examples_folder/myseconddashboard.lvdash.json"
}

Response:
{
        "object_type": "DASHBOARD",
        "path": "/Users/first.last@example.com/examples_folder/myseconddashboard.lvdash.json",
        "object_id": 7616304051637820,
        "resource_id": "9c1fbf4ad3449be67d6cb64c8acc730b"
}

6. lépés: Irányítópult közzététele

Az előző példák a Workspace API-t használták, amely lehetővé tette a Lakeview-irányítópultok általános munkaterület-objektumként való használatát. Az alábbi példa a Lakeview API-t használja a Lakeview-irányítópultokra vonatkozó közzétételi művelet végrehajtásához. Lásd: POST /api/2.0/lakeview/dashboards/{dashboard_id}/published.

Az API-végpont elérési útja tartalmazza az "resource_id" előző példában visszaadott tulajdonságot. A kérelem paramétereiben úgy van beállítvatrue, "embed_credentials" hogy a közzétevő hitelesítő adatai beágyazódjanak az irányítópultba. Ebben az esetben a közzétevő az a felhasználó, aki az engedélyezett API-kérést intézi. A közzétevő nem ágyazhat be más felhasználó hitelesítő adatait. Az irányítópult közzététele című cikkből megtudhatja, hogyan működik a beágyazási hitelesítő adatok beállítása.

A "warehouse_id" tulajdonság beállítja a közzétett irányítópulthoz használni kívánt raktárat. Ha meg van adva, ez a tulajdonság felülbírálja a piszkozat irányítópulthoz megadott raktárat, ha van ilyen.

POST /api/2.0/lakeview/dashboards/9c1fbf4ad3449be67d6cb64c8acc730b/published

Request parameters
{
  "embed_credentials": true,
  "warehouse_id": "1234567890ABCD12"
}

Response:
{}

A közzétett irányítópult a parancs befejeződésekor érhető el a böngészőből. Az alábbi példa bemutatja, hogyan hozhatja létre a közzétett irányítópultra mutató hivatkozást.

https://<deployment-url>/dashboardsv3/<resource_id>/published

Az egyedi hivatkozás létrehozása:

Cserélje le <deployment-url> az üzembehelyezési URL-címet. Ez a hivatkozás a böngésző címsorában található cím, amikor az Azure Databricks-munkaterület kezdőlapján van.
Cserélje le <resource_id> a metaadatok lekérése "resource_id" során azonosított tulajdonság értékét.

7. lépés: Irányítópult törlése

Irányítópult törléséhez használja a Workspace API-t. Lásd: POST /api/2.0/workspace/delete.