Továbbfejlesztett frissítés a Power BI REST API-val

Bármely olyan programozási nyelvet használhat, amely támogatja a REST-hívásokat szemantikai modellfrissítési műveletek végrehajtásához a Power BI Refresh Dataset REST API használatával.

A nagy és összetett particionált modellek optimalizált frissítését hagyományosan tom (táblázatos objektummodell), PowerShell-parancsmagok vagy TMSL (táblázatos modellszkriptnyelv) használó programozási módszerekkel hívjuk meg. Ezek a módszerek azonban hosszú ideig futó HTTP-kapcsolatokat igényelnek, amelyek megbízhatatlanok lehetnek.

A Power BI Refresh Dataset REST API aszinkron módon hajthatja végre a modellfrissítési műveleteket, így az ügyfélalkalmazásokból származó, hosszú ideig futó HTTP-kapcsolatokra nincs szükség. A standard frissítési műveletekhez képest a REST API-val bővített frissítés több testreszabási lehetőséget és a nagy modellek számára hasznos alábbi funkciókat biztosítja:

• Kötegelt véglegesítések
• Tábla- és partíciószintű frissítés
• Növekményes frissítési szabályzatok alkalmazása
• GET frissítés részletei
• Frissítés lemondása
• Időtúllépés konfigurálása

Alap URL-cím

Az alap URL-cím formátuma a következő:

https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/{datasetId}/refreshes 

Az erőforrásokat és műveleteket paraméterek alapján hozzáfűzheti az alap URL-címhez. Az alábbi ábrán Csoportok, Adathalmazokés Frissítésekgyűjtemények. Csoport, Adathalmazés Frissítésobjektumok.

Követelmények

A REST API használatához a következő követelmények szükségesek:

• Szemantikai modell a Power BI Premiumban, prémium felhasználónként vagy Power BI Embeddedben.
• A kérelem URL-címében használandó csoportazonosító és adatkészlet-azonosító.
• Dataset.ReadWrite.All jogosultsági szint.

A frissítések száma a Pro- és Premium-modellek API-alapú frissítéseinek általános korlátozásai szerint korlátozott.

Hitelesítés

Minden hívásnak hitelesítenie kell magát egy érvényes Microsoft Entra ID OAuth 2 tokennel az Authorization fejlécben. A tokennek meg kell felelnie a következő követelményeknek:

• Legyen felhasználói jogkivonat vagy alkalmazási szolgáltatási főfelhasználó.
• Állítsa a célközönséget helyesen https://api.powerbi.comértékre.
• Olyan felhasználó vagy alkalmazás használhatja, amely rendelkezik a modellre vonatkozó megfelelő engedélyekkel.

POST /frissítések

Frissítéshez a /refreshes gyűjtemény POST parancsával adjon hozzá egy új frissítési objektumot a gyűjteményhez. A válasz Location fejléce tartalmazza a requestId. Mivel a művelet aszinkron, az ügyfélalkalmazások leválaszthatják a kapcsolatot, és szükség esetén a requestId segítségével ellenőrizhetik az állapotot.

Az alábbi kód egy mintakérést mutat be:

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes

A kérelem törzse a következő példához hasonlíthat:

{
    "type": "Full",
    "commitMode": "transactional",
    "maxParallelism": 2,
    "retryCount": 2,
    "timeout": "02:00:00",
    "objects": [
        {
            "table": "DimCustomer",
            "partition": "DimCustomer"
        },
        {
            "table": "DimDate"
        }
    ]
}

Paraméterek

Továbbfejlesztett frissítési művelet végrehajtásához meg kell adnia egy vagy több paramétert a kérelem törzsében. A megadott paraméterek megadhatják az alapértelmezett vagy nem kötelező értéket. Amikor a kérelem paramétereket ad meg, az összes többi paraméter az alapértelmezett értékekkel érvényes a műveletre. Ha a kérés nem ad meg paramétereket, az összes paraméter az alapértelmezett értékeket használja, és egy szabványos frissítési művelet történik.

Válasz

202 Accepted

A válasz tartalmaz egy Location válaszfejléc mezőt is, amely a hívót a létrehozott és elfogadott frissítési műveletre mutatja. A Location a kérelem által létrehozott új erőforrás helye, amely magában foglalja azokat a requestId, amelyeket bizonyos továbbfejlesztett frissítési műveletek igényelnek. Az alábbi válaszban például requestId a válasz 87f31ef7-1e3a-4006-9b0b-191693e79e9eutolsó azonosítója.

x-ms-request-id: 87f31ef7-1e3a-4006-9b0b-191693e79e9e
Location: https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes/87f31ef7-1e3a-4006-9b0b-191693e79e9e

GET /refreshs

A /refreshes gyűjtemény GET parancsával listázhatja a korábbi, az aktuális és a függőben lévő frissítési műveleteket.

A válasz törzse a következő példához hasonlóan nézhet ki:

[
    {
        "requestId": "1344a272-7893-4afa-a4b3-3fb87222fdac",
        "refreshType": "ViaEnhancedApi",
        "startTime": "2020-12-07T02:06:57.1838734Z",
        "endTime": "2020-12-07T02:07:00.4929675Z",
        "status": "Completed",
        "extendedStatus": "Completed"
    },
    {
        "requestId": "474fc5a0-3d69-4c5d-adb4-8a846fa5580b",
        "startTime": "2020-12-07T01:05:54.157324Z",
        "refreshType": "ViaEnhancedApi",
        "status": "Unknown"
    }
    {
        "requestId": "85a82498-2209-428c-b273-f87b3a1eb905",
        "refreshType": "ViaEnhancedApi",
        "startTime": "2020-12-07T01:05:54.157324Z",
        "status": "Unknown",
        "extendedStatus": "NotStarted"
    }
]

Válasz jellemzői

A visszaadott frissítési műveletek számának korlátozása

A Power BI REST API támogatja a frissítési előzményekben kért bejegyzések számának korlátozását az opcionális $top paraméter használatával. Ha nincs megadva, alapértelmezés szerint az összes elérhető bejegyzés.

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/{datasetId}/refreshes?$top={$top}      

GET /refreshes/<requestId>

A frissítési művelet állapotának ellenőrzéséhez használja a GET parancsot a frissítési objektumon a requestIdmegadásával. Ha a művelet folyamatban van, statusInProgressad vissza, ahogyan az alábbi példaválasz törzsében látható:

{
    "startTime": "2020-12-07T02:06:57.1838734Z",
    "endTime": "2020-12-07T02:07:00.4929675Z",
    "type": "Full",
    "status": "InProgress",
    "currentRefreshType": "Full",
    "objects": [
        {
            "table": "DimCustomer",
            "partition": "DimCustomer",
            "status": "InProgress"
        },
        {
            "table": "DimDate",
            "partition": "DimDate",
            "status": "InProgress"
        }
    ]
}

DELETE /refreshes/<requestId>

Folyamatban lévő bővített frissítési művelet megszakításához használja a DELETE parancsot a frissítési objektumon a requestIdmegadásával.

Például

DELETE https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes/1344a272-7893-4afa-a4b3-3fb87222fdac

Szempontok és korlátozások

A frissítési művelet a következő szempontokat és korlátozásokat tartalmazza:

Standard frissítési műveletek

• A portál frissítés gombjának DELETE /refreshes/<requestId>használatával aktivált ütemezett vagy igény szerinti modellfrissítések nem szakíthatók meg.
• A portál frissítés gombjának kiválasztásával aktivált ütemezett és igény szerinti modellfrissítések nem támogatják a frissítési művelet részleteinek lekérését GET /refreshes/<requestId>.
• A részletek lekérése és a Mégse funkció csak a továbbfejlesztett frissítéshez használható új műveletek. A standard frissítés nem támogatja ezeket a műveleteket.

Power BI Embedded

Ha a kapacitást manuálisan szünetelteti a Power BI portálon vagy a PowerShell használatával, vagy rendszerkimaradás történik, a folyamatban lévő továbbfejlesztett frissítési művelet állapota legfeljebb hat órán keresztül InProgress marad. Ha a kapacitás hat órán belül újraindul, a frissítési művelet automatikusan folytatódik. Ha a kapacitás több mint hat óra elteltével folytatódik, a frissítési művelet időtúllépési hibát eredményezhet. Ezután újra kell indítania a frissítési műveletet.

Szemantikai modell kizárása

A Power BI dinamikus memóriakezelést használ a kapacitásmemória optimalizálásához. Ha a modell egy frissítési művelet során ki van távolítva a memóriából, a következő hiba fordulhat elő:

{
    "messages": [
        {
            "code": "0xC11C0020",
            "message": "Session cancelled because it is connected to a database that has been evicted to free up memory for other operations",
            "type": "Error"
        }
    ]
}

A megoldás a frissítési művelet újrafuttatása. A dinamikus memóriakezelésről és a modellkivonásról további információt a Modell kivonásicímű témakörben talál.

A frissítési művelet időkorlátjai

A frissítési művelet több kísérletet is tartalmazhat, ha retryCount van megadva. Minden kísérlethez 5 óra alapértelmezett időtúllépés tartozik, amely a timeout paraméterrel módosítható. A frissítés teljes időtartama, beleértve az újrapróbálkozásokat is, nem haladhatja meg a 24 órát.

Ha retryCount egy számot ad meg, egy új frissítési művelet az időtúllépési korláttal kezdődik. A szolgáltatás mindaddig újrapróbálkozza ezt a műveletet, amíg nem sikerül, el nem éri a retryCount korlátot, vagy eléri az első kísérlettől kezdve a 24 órás maximumot.

Módosíthatja a timeout, hogy lerövidítse a frissítés időtartamát a gyorsabb hibaészlelés érdekében, vagy hosszabbítsa meg az alapértelmezett 5 órát az összetettebb adatfrissítések esetében.

Ha a szemantikai modell frissítését a Refresh Dataset REST API-val tervezi, vegye figyelembe az időkorlátokat és az újrapróbálkozási szám paramétert. A frissítés túllépheti az időtúllépést, ha a kezdeti kísérlet meghiúsul, és az újrapróbálkozási szám értéke 1 vagy több. Ha "retryCount" típusú frissítést kér: 1, és az első kísérlet 4 óra után meghiúsul, megkezdődik egy második kísérlet. Ha ez 3 órán belül sikerül, a frissítés teljes ideje 7 óra.

Ha a frissítési műveletek rendszeresen sikertelenek, túllépik az időtúllépési időkorlátot, vagy túllépik a kívánt sikeres frissítési művelet időtartamát, érdemes lehet csökkenteni az adatforrásból frissítendő adatok mennyiségét. A frissítést több kérelemre is feloszthatja, például az egyes táblákra vonatkozó kéréseket. A commitMode paraméterben a partialBatch paramétert is megadhatja.

Kódminta

A kezdéshez egy C# kódminta található a GitHubon RestApiSample néven.

A kódminta használata:

1. Klónozza vagy töltse le az adattárat.
2. Nyissa meg a RestApiSample-megoldást.
3. Keresse meg a sort client.BaseAddress = …, és adja meg a alap URL-címét.

A kódminta szolgáltatásnév-azonosító hitelesítést használ.

Kapcsolódó tartalom

• Power BI adatkészlet frissítése REST API
• A Power BI REST API-k használata