Poznámka
Na prístup k tejto stránke sa vyžaduje oprávnenie. Môžete sa skúsiť prihlásiť alebo zmeniť adresáre.
Na prístup k tejto stránke sa vyžaduje oprávnenie. Môžete skúsiť zmeniť adresáre.
Rozhrania REST API služby Microsoft Fabric poskytujú koncové body služby na správu položiek služby Fabric. Tento článok popisuje verejné rozhrania REST API, ktoré sú k dispozícii pre materializované zobrazenia jazier a ich použitie.
Poznámka
Táto funkcia je momentálne vo verzii Preview.
Pomocou materializovaných rozhraní API pre zobrazenie jazera môžu dátoví inžinieri a občianski vývojári automatizovať svoje vlastné rodokmene. Tieto rozhrania API tiež uľahčujú používateľom správu materiálových zobrazení jazier (MLV) a ich integráciu s inými nástrojmi a systémami.
Nasledujúce akcie plánovača úloh sú k dispozícii pre materializované zobrazenia jazera s overením používateľa.
| Action | Popis |
|---|---|
| Vytvoriť rozvrh položiek | Vytvorte nový rozvrh na obnovenie línie MLV v Lakehouse. |
| Získajte rozvrh položiek | Získajte podrobnosti o existujúcom pláne obnovenia línie MLV v Lakehouse. |
| Zoznam výkazov položiek | Zoznam rozvrhov vytvorených na obnovenie línie MLV v Lakehouse. |
| Aktualizovať plán položiek | Aktualizujte existujúci plán obnovenia rodokmeňa MLV. |
| Odstrániť plán položiek | Odstráňte plán obnovenia rodokmeňa MLV v Lakehouse. |
| Spustiť úlohu položky na požiadanie | Obnovte líniu MLV v Lakehouse ako prácu na požiadanie. |
| Zoznam inštancií úloh položiek | Zoznam všetkých inštancií úloh vytvorených na obnovenie línie MLV v Lakehouse. |
| Získať inštanciu úlohy položky | Získajte podrobnosti o inštancii úlohy pre dokončené obnovenie pôvodu MLV v Lakehouse, ako je napríklad stav. |
| Zrušiť inštanciu úlohy položky | Zrušte prebiehajúcu obnovu línie MLV v Lakehouse. |
Ďalšie informácie nájdete v téme Plánovač úloh s {jobType} názvom RefreshMaterializedLakeViews.
Poznámka
Tieto scenáre sa vzťahujú iba na jedinečné príklady použitia materializovaných zobrazení jazera. Príklady bežného rozhrania API položiek služby Fabric tu nie sú zahrnuté.
Požiadavky
- Ak chcete používať rozhranie REST API služby Fabric, musíte zaregistrovať aplikáciu s ID Microsoft Entra a získať token Microsoft Entra pre službu Fabric. Potom môžete tento token použiť v autorizačnej hlavičke volania API.
- Rozhrania REST API štruktúry pre MLV podporujú používateľov Microsoft Entra. Spôsob autorizácie a rozsah priradený pri vyvolaní rozhraní REST API by sa mali zvoliť na základe spôsobu prístupu k rozhraniam REST API.
- Fabric Rest API definuje jednotný koncový bod pre operácie a poskytuje prístup k rôznym operáciám v rodokmeni. Pri vyvolaní požiadaviek rozhrania API nahraďte zástupné symboly, ako
{WORKSPACE_ID}napríklad ,{LAKEHOUSE_ID}a podrobnosti o objeme dát v nižšie uvedených príkladoch, príslušnými hodnotami.
Príklady použitia rozhrania REST API s materializovanými zobrazeniami jazera
Pomocou nasledujúcich rozhraní API môžete naplánovať, spustiť, načítať a odstrániť úlohy alebo plány na obnovenie pôvodu materializovaných zobrazení jazera.
Vytvorte rozvrh pre MLV v Lakehouse
Vytvorte nový plán na pravidelné obnovenie pôvodu MLV. Ďalšie informácie nájdete v časti Plánovač úloh. V súčasnosti MLV podporuje iba jeden aktívny plán obnovenia na rodokmeň. Použite Aktualizovať plán na aktualizáciu existujúceho plánu.
Žiadosť o vzorku:
POST https://api.fabric.microsoft.com/v1/workspaces/{WORKSPACE_ID}/lakehouses/{LAKEHOUSE_ID}/jobs/RefreshMaterializedLakeViews/schedules
{
"enabled": true,
"configuration": {
"startDateTime": "YYYY-MM-DDTHH:mm:ss",
"endDateTime": "YYYY-MM-DDTHH:mm:ss",
"localTimeZoneId": "Central Standard Time",
"type": "Cron",
"interval": 10
}
}
Ukážka odpovede:
Kód stavu: 201 Vytvorené
Location: https://api.fabric.microsoft.com/v1/workspaces/{WORKSPACE_ID}/lakehouses/{LAKEHOUSE_ID}/jobs/RefreshMaterializedLakeViews/schedules/<scheduleId>
{
"id": "<scheduleId>",
"enabled": true,
"createdDateTime": "YYYY-MM-DDTHH:mm:ss.xxxxxxx",
"configuration": {
"startDateTime": "YYYY-MM-DDTHH:mm:ss",
"endDateTime": "YYYY-MM-DDTHH:mm:ss",
"localTimeZoneId": "Central Standard Time",
"type": "Cron",
"interval": 10
},
"owner": {
"id": "<ownerId>",
"type": "User"
}
}
Získajte rozpis MLV v Lakehouse
Získajte podrobnosti o existujúcom pláne obnovenia rodokmeňa MLV. Ďalšie informácie nájdete v časti Plánovač úloh.
Žiadosť o vzorku:
GET https://api.fabric.microsoft.com/v1/workspaces/{WORKSPACE_ID}/lakehouses/{LAKEHOUSE_ID}/jobs/RefreshMaterializedLakeViews/schedules/{scheduleId}
Ukážka odpovede:
Stavový kód: 200 OK
{
"id": "<scheduleId>",
"enabled": true,
"createdDateTime": "YYYY-MM-DDTHH:mm:ss.xxxxxxx",
"configuration": {
"startDateTime": "YYYY-MM-DDTHH:mm:ss",
"endDateTime": "YYYY-MM-DDTHH:mm:ss",
"localTimeZoneId": "Central Standard Time",
"type": "Cron",
"interval": 10
},
"owner": {
"id": "<ownerId>",
"type": "User"
}
}
Zoznam rozvrhov pre MLV v Lakehouse
Zoznam všetkých plánov obnovenia vytvorených pre pôvod MLV. Ďalšie informácie nájdete v časti Plánovač úloh.
Žiadosť o vzorku:
GET https://api.fabric.microsoft.com/v1/workspaces/{WORKSPACE_ID}/lakehouses/{LAKEHOUSE_ID}/jobs/RefreshMaterializedLakeViews/schedules
Ukážka odpovede:
Stavový kód: 200 OK
{
"value": [
{
"id": "<scheduleId_1",
"enabled": true,
"createdDateTime": "YYYY-MM-DDTHH:mm:ss.xxxxxxx",
"configuration": {
"startDateTime": "YYYY-MM-DDTHH:mm:ss",
"endDateTime": "YYYY-MM-DDTHH:mm:ss",
"localTimeZoneId": "Central Standard Time",
"type": "Weekly",
"weekdays": [
"Monday",
"Tuesday"
],
"times": [
"HH:mm",
"HH:mm"
]
},
"owner": {
"id": "<ownerid>",
"type": "User"
}
},
{
"id": "scheduleId_2",
"enabled": true,
"createdDateTime": "YYYY-MM-DDTHH:mm:ss.xxxxxxx",
"configuration": {
"startDateTime": "YYYY-MM-DDTHH:mm:ss",
"endDateTime": "YYYY-MM-DDTHH:mm:ss",
"localTimeZoneId": "Central Standard Time",
"type": "Daily",
"times": [
"HH:mm",
"HH:mm"
]
},
"owner": {
"id": "<ownerid>",
"type": "User"
}
}
]
}
Plán aktualizácie MLV v Lakehouse
Aktualizujte existujúci plán obnovenia pre pôvod MLV. Ďalšie informácie nájdete v časti Plánovač úloh. V súčasnosti MLV podporuje iba jeden aktívny rozvrh na rodokmeň.
Žiadosť o vzorku:
PATCH https://api.fabric.microsoft.com/v1/workspaces/{WORKSPACE_ID}/lakehouses/{LAKEHOUSE_ID}/jobs/RefreshMaterializedLakeViews/schedules/{scheduleId}
{
"enabled": true,
"configuration": {
"startDateTime": "YYYY-MM-DDTHH:mm:ss",
"endDateTime": "YYYY-MM-DDTHH:mm:ss",
"localTimeZoneId": "Central Standard Time",
"type": "Cron",
"interval": 10
}
}
Ukážka odpovede:
Stavový kód: 200 OK'
{
"id": "<scheduleId>",
"enabled": true,
"createdDateTime": "YYYY-MM-DDTHH:mm:ss.xxxxxxx",
"configuration": {
"startDateTime": "YYYY-MM-DDTHH:mm:ss",
"endDateTime": "YYYY-MM-DDTHH:mm:ss",
"localTimeZoneId": "Central Standard Time",
"type": "Cron",
"interval": 10
},
"owner": {
"id": "<ownerId>",
"type": "User"
}
}
Odstrániť rozpis pre MLV v Lakehouse
Odstráňte existujúci plán obnovenia pre pôvod MLV. Ďalšie informácie nájdete v časti Plánovač úloh.
Žiadosť o vzorku:
DELETE https://api.fabric.microsoft.com/v1/workspaces/{WORKSPACE_ID}/lakehouses/{LAKEHOUSE_ID}/jobs/RefreshMaterializedLakeViews/schedules/{scheduleId}
Ukážka odpovede:
Stavový kód: 200 OK
Spustiť prácu na požiadanie pre MLV v Lakehouse
Spustite okamžité obnovenie rodokmeňa MLV v Lakehouse pomocou úlohy na požiadanie. Úloha Spark sa spustí po úspešnej požiadavke. Ďalšie informácie nájdete v časti Plánovač úloh.
Žiadosť o vzorku:
POST https://api.fabric.microsoft.com/v1/workspaces/{WORKSPACE_ID}/lakehouses/{LAKEHOUSE_ID}/jobs/instances?jobType=RefreshMaterializedLakeViews
Ukážka odpovede:
Stavový kód: 202 Akceptované
Location: https://api.fabric.microsoft.com/v1/workspaces/<WORKSPACE_ID>/lakehouses/<LAKEHOUSE_ID>/jobs/instances/<jobInstanceId>
Retry-After: 60
Pomocou locationprogramu môžete použiť príkaz Získať inštanciu úlohy na zobrazenie stavu úlohy alebo použiť možnosť Zrušiť inštanciu úlohy položky na zrušenie aktuálneho spustenia rodokmeňa.
Zoznam pracovných inštancií pre MLV v Lakehouse
Zobrazí zoznam inštancií úloh vykonaných pre obnovenie rodokmeňa MLV v Lakehouse. Ďalšie informácie nájdete v časti Plánovač úloh. Vrátený stav úlohy odráža stav zobrazený v centre monitorovania.
Žiadosť o vzorku:
GET https://api.fabric.microsoft.com/v1/workspaces/{WORKSPACE_ID}/lakehouses/{LAKEHOUSE_ID}/jobs/RefreshMaterializedLakeViews/instances
Ukážka odpovede:
Stavový kód: 200
{
"value": [
{
"id": "<jobInstanceId_1>",
"itemId": "<LAKEHOUSE_ID>",
"jobType": "RefreshMaterializedLakeViews",
"invokeType": "Manual",
"status": "<status>",
"rootActivityId": "<rootActivityId_1>",
"startTimeUtc": "YYYY-MM-DDTHH:mm:ss.xxxxxxx",
"endTimeUtc": "YYYY-MM-DDTHH:mm:ss.xxxxxxx",
"failureReason": null
},
{
"id": "<jobInstanceId_2>",
"itemId": "<LAKEHOUSE_ID>",
"jobType": "RefreshMaterializedLakeViews",
"invokeType": "Scheduled",
"status": "<status>",
"rootActivityId": "rootActivityId_2",
"startTimeUtc": "YYYY-MM-DDTHH:mm:ss.xxxxxxx",
"endTimeUtc": "YYYY-MM-DDTHH:mm:ss.xxxxxxx",
"failureReason": null
}
]
}
Získajte podrobnosti o inštancii úlohy pre MLV v Lakehouse
Získajte podrobnosti o spustení, ako je stav a ID konkrétnej inštancie úlohy obnovenia rodokmeňa MLV. Ďalšie informácie nájdete v časti Plánovač úloh. Vrátený stav úlohy odráža stav zobrazený v centre monitorovania.
Žiadosť o vzorku:
GET https://api.fabric.microsoft.com/v1/workspaces/{WORKSPACE_ID}/lakehouses/{LAKEHOUSE_ID}/jobs/instances/{jobInstanceId}
Ukážka odpovede:
Stavový kód: 200
{
"id": "<id>",
"itemId": "<itemId>",
"jobType": "RefreshMaterializedLakeViews",
"invokeType": "<invokeType>",
"status": "<status>",
"rootActivityId": "<rootActivityId>",
"startTimeUtc": "YYYY-MM-DDTHH:mm:ss.xxxxxxx",
"endTimeUtc": "YYYY-MM-DDTHH:mm:ss.xxxxxxx",
"failureReason": null
}
Zrušiť inštanciu úlohy pre MLV v Lakehouse
Zrušte prebiehajúcu úlohu obnovenia pôvodu MLV. Ďalšie informácie nájdete v časti Plánovač úloh.
Žiadosť o vzorku:
POST https://api.fabric.microsoft.com/v1/workspaces/{WORKSPACE_ID}/lakehouses/{LAKEHOUSE_ID}/jobs/RefreshMaterializedLakeViews/schedules/{jobInstanceId}/cancel
Ukážka odpovede:
Stavový kód: 202 Akceptované
Location: https://api.fabric.microsoft.com/v1/workspaces/<worksapceId>/lakehouses/<LAKEHOUSE_ID>/jobs/instances/<jobInstanceId>
Retry-after: 60
Známe obmedzenia
- Overovanie objektu služby: Materialized Lake Views (MLV) v súčasnosti nepodporujú overovanie prostredníctvom objektov služby.
- Limity harmonogramu na Lakehouse:Plánovač úloh vynucuje obmedzenia počtu plánov, ktoré je možné nakonfigurovať na jazero. Používatelia by mali podľa toho plánovať, aby sa vyhli prekročeniu týchto limitov.
- Jeden rozvrh na líniu: MLV podporuje iba jeden aktívny plán obnovenia na rodokmeň. Pokus o vytvorenie viac ako jedného plánu obnovenia pre rodokmeň môže mať za následok nestabilitu používateľského rozhrania.
- Zobrazenie stavu úlohy: Stav úlohy vrátený inštanciami úloh položky zoznamu a rozhraniami API inštancie úlohy získať položku odráža stav zobrazený v centre monitorovania. Tento stav sa môže líšiť od stavu zobrazeného v histórii spustenia MLV, napríklad Vynechané sa zobrazí ako Zrušené v centre monitorovania.
- Limity zobrazenia entít: Rozhranie plánovača úloh zobrazuje obmedzený počet dokončených a aktívnych úloh. Toto obmedzenie môže ovplyvniť prehľad o historických alebo súbežných spusteniach úloh.