Datasets - Refresh Dataset

Služba:
Power BI REST APIs
Verze rozhraní API:
v1.0

Aktivuje aktualizaci pro zadanou datovou sadu z Můj pracovní prostor. rozšířené aktualizace se aktivuje jenom v případě, že je nastavená datová část požadavku než notifyOption.

Požadovaný obor

Dataset.ReadWrite.All

Omezení

  • U sdílených kapacit je možné zahájit maximálně osm požadavků za den, včetně aktualizací spuštěných pomocí plánované aktualizace.
  • Pro sdílené kapacity je možné v textu požadavku zadat pouze notifyOption.
  • U sdílených kapacit se rozšířená aktualizace nepodporuje.
  • Pro rozšířenou aktualizaci není notifyOption vyžadována a musí být vyloučena z textu požadavku. Vyžaduje se však jeden nebo více parametrů než notifyOption.
  • U kapacit Premium platí, že maximální počet požadavků za den je omezen pouze dostupnými prostředky v kapacitě. Pokud jsou dostupné prostředky přetížené, aktualizace se omezí, dokud se zatížení nezmenší. Aktualizace se nezdaří, pokud omezování překročí 1 hodinu. 

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
datasetId
 path True

string

ID datové sady

Text požadavku

Name Vyžadováno Typ Description
notifyOption True

NotifyOption

Možnosti e-mailových oznámení. Tento parametr se nevztahuje na rozšířené aktualizace nebo operace rozhraní API s instančním objektem.
applyRefreshPolicy

boolean

Určení, jestli se zásady použijí nebo ne
commitMode

DatasetCommitMode

Určuje, zda budou objekty potvrzeny v dávkách nebo pouze po dokončení.
effectiveDate

string (date-time)

Pokud se použije zásada přírůstkové aktualizace, parametr effectiveDate přepíše aktuální datum.
maxParallelism

integer

Maximální počet vláken, na kterých se mají spouštět příkazy paralelního zpracování
objects

DatasetRefreshObjects[]

Pole objektů, které se mají zpracovat
retryCount

integer

Počet opakování operace před selháním Dočasné vnitřní chyby mohou aktivovat opakování aktualizace, i když je tento parametr nastaven na hodnotu 0.
timeout

string

pattern: ^([0-1]?[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$

Pokud je zadán timeout, bude každý pokus o aktualizaci dat v sémantickém modelu dodržovat tento časový limit. Všimněte si, že jeden požadavek na aktualizaci může obsahovat více pokusů, pokud je zadán retryCount, což může způsobit, že celková doba trvání aktualizace překročí zadaný časový limit. Například nastavení timeout 1 hodiny s retryCount 2 hodin může mít za následek celkovou dobu aktualizace až 3 hodiny. Uživatelé můžou upravit timeout tak, aby zkrátili dobu trvání aktualizace, aby se zrychlila detekce selhání, nebo ji prodlužovat nad rámec výchozích 5 hodin pro složitější aktualizace dat. Celková doba trvání aktualizace, včetně opakování, však nesmí překročit 24 hodin.
type

DatasetRefreshType

Typ zpracování, který se má provést

Odpovědi

Name Typ Description
202 Accepted

Přijal

Hlavičky

  • x-ms-request-id: string
  • Location: string

Příklady

Example of refreshing a dataset
Example of refreshing one partition

Example of refreshing a dataset

Ukázkový požadavek

POST https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes

Ukázková odpověď

Stavový kód:
202 
x-ms-request-id: 03f22bb5-2e98-4ae8-8113-329bec3987b1
Location: https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes/03f22bb5-2e98-4ae8-8113-329bec3987b1

Example of refreshing one partition

Ukázkový požadavek

POST https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes
Text požadavku
{
  "type": "full",
  "commitMode": "transactional",
  "objects": [
    {
      "table": "Customer",
      "partition": "Robert"
    }
  ],
  "applyRefreshPolicy": "false",
  "timeout": "05:00:00"
}

Ukázková odpověď

Stavový kód:
200

Definice

Name Description
DatasetCommitMode

Určuje, zda budou objekty potvrzeny v dávkách nebo pouze po dokončení.
DatasetRefreshObjects

Cíl aktualizace datové sady Power BI
DatasetRefreshRequest

Žádost o aktualizaci datové sady Power BI
DatasetRefreshType

Typ zpracování, který se má provést
NotifyOption

Možnosti oznámení pošty

DatasetCommitMode

Výčet

Určuje, zda budou objekty potvrzeny v dávkách nebo pouze po dokončení.

Hodnota Description
Transactional

Potvrzení celé operace aktualizace jako transakce
PartialBatch

Potvrďte operaci aktualizace v dávkách. Při použití partialBatch režimu nedojde k operaci aktualizace v rámci transakce. V důsledku toho se každý příkaz potvrdí jednotlivě a v případě selhání může model skončit ve stavu, kdy se načte pouze podmnožina dat, nebo tabulka zůstane prázdná. Pokud chcete zaručit zachování předchozích dat v případě selhání, měli byste operaci provést s commitMode = transactional.

DatasetRefreshObjects

Objekt

Cíl aktualizace datové sady Power BI

Name Typ Description
partition

string

Oddíl pro aktualizaci
table

string

Tabulka, která se má aktualizovat

DatasetRefreshRequest

Objekt

Žádost o aktualizaci datové sady Power BI

Name Typ Description
applyRefreshPolicy

boolean

Určení, jestli se zásady použijí nebo ne
commitMode

DatasetCommitMode

Určuje, zda budou objekty potvrzeny v dávkách nebo pouze po dokončení.
effectiveDate

string (date-time)

Pokud se použije zásada přírůstkové aktualizace, parametr effectiveDate přepíše aktuální datum.
maxParallelism

integer

Maximální počet vláken, na kterých se mají spouštět příkazy paralelního zpracování
notifyOption

NotifyOption

Možnosti e-mailových oznámení. Tento parametr se nevztahuje na rozšířené aktualizace nebo operace rozhraní API s instančním objektem.
objects

DatasetRefreshObjects[]

Pole objektů, které se mají zpracovat
retryCount

integer

Počet opakování operace před selháním Dočasné vnitřní chyby mohou aktivovat opakování aktualizace, i když je tento parametr nastaven na hodnotu 0.
timeout

string

pattern: ^([0-1]?[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$

Pokud je zadán timeout, bude každý pokus o aktualizaci dat v sémantickém modelu dodržovat tento časový limit. Všimněte si, že jeden požadavek na aktualizaci může obsahovat více pokusů, pokud je zadán retryCount, což může způsobit, že celková doba trvání aktualizace překročí zadaný časový limit. Například nastavení timeout 1 hodiny s retryCount 2 hodin může mít za následek celkovou dobu aktualizace až 3 hodiny. Uživatelé můžou upravit timeout tak, aby zkrátili dobu trvání aktualizace, aby se zrychlila detekce selhání, nebo ji prodlužovat nad rámec výchozích 5 hodin pro složitější aktualizace dat. Celková doba trvání aktualizace, včetně opakování, však nesmí překročit 24 hodin.
type

DatasetRefreshType

Typ zpracování, který se má provést

DatasetRefreshType

Výčet

Typ zpracování, který se má provést

Hodnota Description
Full

Pro všechny oddíly v zadaném oddílu, tabulce nebo databázi aktualizujte data a přepočítáte všechny závislé. U oddílu výpočtu přepočítáte oddíl a všechny jeho závislé objekty.
ClearValues

Vymazat hodnoty v tomto objektu a všechny jeho závislé
Calculate

Přepočítejte tento objekt a všechny jeho závislé objekty, ale pouze v případě potřeby. Tato hodnota nevynucuje přepočet, s výjimkou nestálých vzorců.
DataOnly

Aktualizace dat v tomto objektu a vymazání všech závislých objektů
Automatic

Pokud je potřeba objekt aktualizovat a přepočítat, aktualizujte a přepočítejte objekt a všechny jeho závislé objekty. Platí, pokud je oddíl v jiném stavu než Připraveno.
Defragment

Defragmentace dat v zadané tabulce Při přidání nebo odebrání dat z tabulky se slovníky jednotlivých sloupců můžou znečistit hodnotami, které už ve skutečných hodnotách sloupců neexistují. Možnost defragmentace vyčistí hodnoty ve slovníkech, které se už nepoužívají.

NotifyOption

Výčet

Možnosti oznámení pošty

Hodnota Description
NoNotification

Nebudou odeslána žádná oznámení.
MailOnFailure

Při selhání aktualizace se odešle e-mailové oznámení.
MailOnCompletion

E-mailové oznámení o úspěchu nebo selhání se odešle po dokončení aktualizace.