Datasets - Refresh Dataset

Usługa:

Power BI REST APIs

Wersja interfejsu API:

v1.0

Wyzwala odświeżanie określonego zestawu danych z Mój obszar roboczy. 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	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.
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"
}

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

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

Nazwa	Typ	Opis
PartialBatch	string	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.
Transactional	string	Zatwierdzanie całej operacji odświeżania jako transakcji

DatasetRefreshObjects

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

Żą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	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.
type	DatasetRefreshType	Typ przetwarzania do wykonania

DatasetRefreshType

Typ przetwarzania do wykonania

Nazwa	Typ	Opis
Automatic	string	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.
Calculate	string	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.
ClearValues	string	Wyczyść wartości w tym obiekcie i wszystkie jego zależności
DataOnly	string	Odśwież dane w tym obiekcie i wyczyść wszystkie zależności
Defragment	string	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.
Full	string	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.

NotifyOption

Opcje powiadomień e-mail

Nazwa	Typ	Opis
MailOnCompletion	string	Powiadomienie e-mail wskazujące powodzenie lub niepowodzenie zostanie wysłane po zakończeniu odświeżania
MailOnFailure	string	Powiadomienie e-mail zostanie wysłane po niepowodzeniu odświeżania
NoNotification	string	Powiadomienie nie zostanie wysłane