Datasets - Refresh Dataset

  • Referenz
Dienst:
Power BI REST APIs
API-Version:
v1.0

Löst eine Aktualisierung für das angegebene Dataset aus My workspaceaus. Eine erweiterte Aktualisierungs- wird nur ausgelöst, wenn eine andere Anforderungsnutzlast als notifyOption festgelegt ist.

Erforderlicher Bereich

Dataset.ReadWrite.All

Begrenzungen

  • Für freigegebene Kapazitäten können maximal acht Anforderungen pro Tag, einschließlich Aktualisierungen, die mithilfe der geplanten Aktualisierung ausgeführt werden, initiiert werden.
  • Bei freigegebenen Kapazitäten kann nur notifyOption im Anforderungstext angegeben werden.
  • Die erweiterte Aktualisierung wird für gemeinsame Kapazitäten nicht unterstützt.
  • Für eine erweiterte Aktualisierung ist notifyOption nicht erforderlich und muss vom Anforderungstext ausgeschlossen werden. Ein oder mehrere andere Parameter als notifyOption sind jedoch erforderlich.
  • Für Premium-Kapazitäten sind die maximalen Anforderungen pro Tag nur durch die verfügbaren Ressourcen in der Kapazität begrenzt. Wenn verfügbare Ressourcen überladen sind, werden Aktualisierungen gedrosselt, bis die Last reduziert wird. Die Aktualisierung schlägt fehl, wenn die Drosselung 1 Stunde überschreitet. 

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
datasetId
 path True

string

Die Dataset-ID

Anforderungstext

Name Erforderlich Typ Beschreibung
notifyOption True

NotifyOption

E-Mail-Benachrichtigungsoptionen. Dieser Parameter gilt nicht für erweiterte Aktualisierungen oder API-Vorgänge mit einem Dienstprinzipal.
applyRefreshPolicy

boolean

Ermitteln, ob die Richtlinie angewendet wird oder nicht
commitMode

DatasetCommitMode

Bestimmt, ob Objekte in Batches oder nur nach Abschluss zugesichert werden.
effectiveDate

string

Wenn eine inkrementelle Aktualisierungsrichtlinie angewendet wird, überschreibt der parameter effectiveDate das aktuelle Datum.
maxParallelism

integer

Die maximale Anzahl von Threads, für die parallele Verarbeitungsbefehle ausgeführt werden sollen
objects

DatasetRefreshObjects[]

Ein Array von Objekten, die verarbeitet werden sollen
retryCount

integer

Anzahl der Wiederholungen des Vorgangs vor einem Fehlschlagen. Temporäre interne Fehler können einen Wiederholungsversuche der Aktualisierung auslösen, auch wenn dieser Parameter auf 0 festgelegt ist.
type

DatasetRefreshType

Der Typ der auszuführenden Verarbeitung

Antworten

Name Typ Beschreibung
202 Accepted

Angenommen

Header

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

Beispiele

Example of refreshing a dataset
Example of refreshing one partition

Example of refreshing a dataset

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
200

Definitionen

Name Beschreibung
DatasetCommitMode

Bestimmt, ob Objekte in Batches oder nur nach Abschluss zugesichert werden.
DatasetRefreshObjects

Power BI-Datasetaktualisierungsziel
DatasetRefreshRequest

Aktualisierungsanforderung für Power BI-Datasets
DatasetRefreshType

Der Typ der auszuführenden Verarbeitung
NotifyOption

E-Mail-Benachrichtigungsoptionen

DatasetCommitMode

Bestimmt, ob Objekte in Batches oder nur nach Abschluss zugesichert werden.

Name Typ Beschreibung
PartialBatch

string

Übernehmen Sie den Aktualisierungsvorgang in Batches. Wenn sie partialBatch Modus verwenden, tritt der Aktualisierungsvorgang nicht innerhalb einer Transaktion auf. Folglich wird jeder Befehl einzeln ausgeführt, und im Falle eines Fehlers kann das Modell in einem Zustand enden, in dem nur eine Teilmenge der Daten geladen wird, oder die Tabelle bleibt leer. Wenn Sie die Erhaltung früherer Daten im Falle eines Fehlers garantieren möchten, sollten Sie den Vorgang mit commitMode = transactional.
Transactional

string

Commit des gesamten Aktualisierungsvorgangs als Transaktion

DatasetRefreshObjects

Power BI-Datasetaktualisierungsziel

Name Typ Beschreibung
partition

string

Zu aktualisierende Partition
table

string

Zu aktualisierende Tabelle

DatasetRefreshRequest

Aktualisierungsanforderung für Power BI-Datasets

Name Typ Beschreibung
applyRefreshPolicy

boolean

Ermitteln, ob die Richtlinie angewendet wird oder nicht
commitMode

DatasetCommitMode

Bestimmt, ob Objekte in Batches oder nur nach Abschluss zugesichert werden.
effectiveDate

string

Wenn eine inkrementelle Aktualisierungsrichtlinie angewendet wird, überschreibt der parameter effectiveDate das aktuelle Datum.
maxParallelism

integer

Die maximale Anzahl von Threads, für die parallele Verarbeitungsbefehle ausgeführt werden sollen
notifyOption

NotifyOption

E-Mail-Benachrichtigungsoptionen. Dieser Parameter gilt nicht für erweiterte Aktualisierungen oder API-Vorgänge mit einem Dienstprinzipal.
objects

DatasetRefreshObjects[]

Ein Array von Objekten, die verarbeitet werden sollen
retryCount

integer

Anzahl der Wiederholungen des Vorgangs vor einem Fehlschlagen. Temporäre interne Fehler können einen Wiederholungsversuche der Aktualisierung auslösen, auch wenn dieser Parameter auf 0 festgelegt ist.
type

DatasetRefreshType

Der Typ der auszuführenden Verarbeitung

DatasetRefreshType

Der Typ der auszuführenden Verarbeitung

Name Typ Beschreibung
Automatic

string

Wenn das Objekt aktualisiert und neu berechnet werden muss, aktualisieren und berechnen Sie das Objekt und alle nachfolger. Gilt, wenn sich die Partition in einem anderen Zustand als "Ready" befindet.
Calculate

string

Berechnen Sie dieses Objekt und alle abhängigen Objekte neu, aber nur bei Bedarf. Dieser Wert erzwingt keine Neuberechnung, außer bei veränderliche Formeln.
ClearValues

string

Löschen von Werten in diesem Objekt und allen abhängigen Objekten
DataOnly

string

Aktualisieren von Daten in diesem Objekt und Löschen aller Abhängigen
Defragment

string

Defragmentieren sie die Daten in der angegebenen Tabelle. Wenn Daten zu einer Tabelle hinzugefügt oder daraus entfernt werden, können die Wörterbücher jeder Spalte mit Werten verunreinigt werden, die nicht mehr in den tatsächlichen Spaltenwerten vorhanden sind. Die Defragmentierungsoption bereinigt die Werte in den Wörterbüchern, die nicht mehr verwendet werden.
Full

string

Aktualisieren Sie für alle Partitionen in der angegebenen Partition, Tabelle oder Datenbank Daten, und berechnen Sie alle Abhängigen neu. Bei einer Berechnungspartition müssen Sie die Partition und alle abhängigen Partitionen neu berechnen.

NotifyOption

E-Mail-Benachrichtigungsoptionen

Name Typ Beschreibung
MailOnCompletion

string

Eine E-Mail-Benachrichtigung, die angibt, dass der Aktualisierungsvorgang erfolgreich oder fehlgeschlagen ist
MailOnFailure

string

Beim Aktualisierungsfehler wird eine E-Mail-Benachrichtigung gesendet.
NoNotification

string

Es wird keine Benachrichtigung gesendet.