Datasets - Refresh Dataset

Usługa:
Power BI REST APIs
Wersja interfejsu API:
v1.0

Wyzwala odświeżanie określonego modelu semantycznego. Model semantyczny może znajdować się w obszarze Mój obszar roboczy lub inny obszar roboczy, pod warunkiem, że obiekt wywołujący ma wymagane uprawnienia. rozszerzone odświeżanie jest wyzwalane tylko wtedy, gdy ustawiono ładunek żądania inny niż notifyOption.

Wymagany zakres

Dataset.ReadWrite.All

Ograniczenia

  • W przypadku pojemności udostępnionych można zainicjować maksymalnie osiem żądań dziennie, w tym odświeżenia wykonywane przy użyciu zaplanowanego odświeżania.
  • W przypadku pojemności udostępnionych można określić tylko notifyOption w treści żądania.
  • Rozszerzone odświeżanie nie jest obsługiwane w przypadku pojemności udostępnionych.
  • W przypadku odświeżania rozszerzonego notifyOption nie jest wymagany i musi zostać wykluczony z treści żądania. Wymagany jest jednak co najmniej jeden parametr inny niż notifyOption.
  • W przypadku pojemności Premium maksymalna liczba żądań dziennie jest ograniczona tylko przez dostępne zasoby w pojemności. Jeśli dostępne zasoby są przeciążone, odświeżanie jest ograniczane do momentu zmniejszenia obciążenia. Odświeżanie zakończy się niepowodzeniem, jeśli ograniczenie przepustowości przekroczy 1 godzinę. 

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
datasetId
 path True

string

Identyfikator zestawu danych

Treść żądania

Nazwa Wymagane Typ Opis
notifyOption True

NotifyOption

Opcje powiadomień e-mail. Ten parametr nie ma zastosowania do rozszerzonych odświeżeń ani operacji interfejsu API z jednostką usługi.
applyRefreshPolicy

boolean

Określanie, czy zasady są stosowane, czy nie
commitMode

DatasetCommitMode

Określa, czy obiekty zostaną zatwierdzone w partiach lub tylko po zakończeniu
effectiveDate

string (date-time)

Jeśli zastosowano zasady odświeżania przyrostowego, parametr effectiveDate zastępuje bieżącą datę.
maxParallelism

integer

Maksymalna liczba wątków, na których można uruchamiać polecenia przetwarzania równoległego
objects

DatasetRefreshObjects[]

Tablica obiektów do przetworzenia
retryCount

integer

Liczba ponownych prób wykonania operacji przed niepowodzeniem. Tymczasowe błędy wewnętrzne mogą wyzwolić ponowienie próby odświeżenia, nawet jeśli ten parametr ma wartość 0.
timeout

string

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

Jeśli określono timeout, każda próba odświeżenia danych w modelu semantycznym będzie zgodna z tym limitem czasu. Należy pamiętać, że pojedyncze żądanie odświeżania może zawierać wiele prób, jeśli określono retryCount, co może spowodować przekroczenie limitu czasu całkowitego czasu odświeżania. Na przykład ustawienie timeout na 1 godzinę i retryCount na 2 może skutkować całkowitym czasem odświeżania wynoszącym do 3 godzin. Użytkownicy mogą dostosować timeout, aby skrócić czas trwania odświeżania w celu szybszego wykrywania błędów lub rozszerzyć go poza domyślne 5 godzin w celu bardziej złożonych odświeżeń danych. Jednak łączny czas trwania odświeżania, w tym ponownych prób, nie może przekraczać 24 godzin.
type

DatasetRefreshType

Typ przetwarzania do wykonania

Odpowiedzi

Nazwa Typ Opis
202 Accepted

Akceptowane

Nagłówki

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

Przykłady

Example of refreshing a dataset
Example of refreshing one partition

Example of refreshing a dataset

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
200

Definicje

Nazwa Opis
DatasetCommitMode

Określa, czy obiekty zostaną zatwierdzone w partiach lub tylko po zakończeniu
DatasetRefreshObjects

Element docelowy odświeżania zestawu danych usługi Power BI
DatasetRefreshRequest

Żądanie odświeżania zestawu danych usługi Power BI
DatasetRefreshType

Typ przetwarzania do wykonania
NotifyOption

Opcje powiadomień e-mail

DatasetCommitMode

Wyliczenie

Określa, czy obiekty zostaną zatwierdzone w partiach lub tylko po zakończeniu

Wartość Opis
Transactional

Zatwierdzanie całej operacji odświeżania jako transakcji
PartialBatch

Zatwierdź operację odświeżania w partiach. W przypadku korzystania z trybu partialBatch operacja odświeżania nie występuje w ramach transakcji. W związku z tym każde polecenie zostanie zatwierdzone indywidualnie, a w przypadku awarii model może znajdować się w stanie, w którym ładowany jest tylko podzbiór danych lub tabela jest pozostawiona pusta. Jeśli chcesz zagwarantować zachowanie poprzednich danych w przypadku awarii, należy wykonać operację z commitMode = transactional.

DatasetRefreshObjects

Objekt

Element docelowy odświeżania zestawu danych usługi Power BI

Nazwa Typ Opis
partition

string

Partycja do odświeżenia
table

string

Tabela do odświeżenia

DatasetRefreshRequest

Objekt

Żądanie odświeżania zestawu danych usługi Power BI

Nazwa Typ Opis
applyRefreshPolicy

boolean

Określanie, czy zasady są stosowane, czy nie
commitMode

DatasetCommitMode

Określa, czy obiekty zostaną zatwierdzone w partiach lub tylko po zakończeniu
effectiveDate

string (date-time)

Jeśli zastosowano zasady odświeżania przyrostowego, parametr effectiveDate zastępuje bieżącą datę.
maxParallelism

integer

Maksymalna liczba wątków, na których można uruchamiać polecenia przetwarzania równoległego
notifyOption

NotifyOption

Opcje powiadomień e-mail. Ten parametr nie ma zastosowania do rozszerzonych odświeżeń ani operacji interfejsu API z jednostką usługi.
objects

DatasetRefreshObjects[]

Tablica obiektów do przetworzenia
retryCount

integer

Liczba ponownych prób wykonania operacji przed niepowodzeniem. Tymczasowe błędy wewnętrzne mogą wyzwolić ponowienie próby odświeżenia, nawet jeśli ten parametr ma wartość 0.
timeout

string

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

Jeśli określono timeout, każda próba odświeżenia danych w modelu semantycznym będzie zgodna z tym limitem czasu. Należy pamiętać, że pojedyncze żądanie odświeżania może zawierać wiele prób, jeśli określono retryCount, co może spowodować przekroczenie limitu czasu całkowitego czasu odświeżania. Na przykład ustawienie timeout na 1 godzinę i retryCount na 2 może skutkować całkowitym czasem odświeżania wynoszącym do 3 godzin. Użytkownicy mogą dostosować timeout, aby skrócić czas trwania odświeżania w celu szybszego wykrywania błędów lub rozszerzyć go poza domyślne 5 godzin w celu bardziej złożonych odświeżeń danych. Jednak łączny czas trwania odświeżania, w tym ponownych prób, nie może przekraczać 24 godzin.
type

DatasetRefreshType

Typ przetwarzania do wykonania

DatasetRefreshType

Wyliczenie

Typ przetwarzania do wykonania

Wartość Opis
Full

Dla wszystkich partycji w określonej partycji, tabeli lub bazie danych odśwież dane i oblicz ponownie wszystkie zależności. W przypadku partycji obliczeniowej oblicz ponownie partycję i wszystkie jej zależności.
ClearValues

Wyczyść wartości w tym obiekcie i wszystkie jego zależności
Calculate

Oblicz ponownie ten obiekt i wszystkie jego zależności, ale tylko w razie potrzeby. Ta wartość nie wymusza ponownego obliczania, z wyjątkiem formuł nietrwałych.
DataOnly

Odśwież dane w tym obiekcie i wyczyść wszystkie zależności
Automatic

Jeśli obiekt musi zostać odświeżony i ponownie obliczony, odśwież i oblicz ponownie obiekt oraz wszystkie jego zależności. Dotyczy, jeśli partycja jest w stanie innym niż Gotowe.
Defragment

Defragmentuj dane w określonej tabeli. W miarę dodawania lub usuwania danych z tabeli słowniki każdej kolumny mogą stać się zanieczyszczone wartościami, które już nie istnieją w rzeczywistych wartościach kolumn. Opcja defragmentacji wyczyści wartości w słownikach, które nie są już używane.

NotifyOption

Wyliczenie

Opcje powiadomień e-mail

Wartość Opis
NoNotification

Powiadomienie nie zostanie wysłane
MailOnFailure

Powiadomienie e-mail zostanie wysłane po niepowodzeniu odświeżania
MailOnCompletion

Powiadomienie e-mail wskazujące powodzenie lub niepowodzenie zostanie wysłane po zakończeniu odświeżania