Capacities - Get Refreshables For Capacity

Referenz

Service:: Power BI REST APIs

API Version:: v1.0

Gibt eine Liste der Aktualisierungen für die angegebene Kapazität zurück, auf die der Benutzer Zugriff hat.

Power BI behält einen siebentägigen Aktualisierungsverlauf für jedes Dataset bei, bis zu maximal sechzig Aktualisierungen.

Erforderlicher Bereich

Capacity.Read.All oder Capacity.ReadWrite.All

GET https://api.powerbi.com/v1.0/myorg/capacities/{capacityId}/refreshables?$top={$top}

With optional parameters:

GET https://api.powerbi.com/v1.0/myorg/capacities/{capacityId}/refreshables?$expand={$expand}&$filter={$filter}&$top={$top}&$skip={$skip}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
capacityId	path	True	string uuid	Die Kapazitäts-ID
$top	query	True	integer int32	Gibt nur die ersten n-Ergebnisse zurück.
$expand	query		string	Akzeptiert eine durch Trennzeichen getrennte Liste von Datentypen, die in der Antwort inline erweitert wird. Unterstützt `capacities` und `groups`.
$filter	query		string	Filtert die Ergebnisse basierend auf einer booleschen Bedingung
$skip	query		integer int32	Überspringt die ersten n-Ergebnisse. Verwenden Sie mit top, um Ergebnisse ab den ersten 1000 abzurufen.

Antworten

Name	Typ	Beschreibung
200 OK	Refreshables	OK

Beispiele

Example

Get refreshables, filtering for an average refresh duration of greater than 30 minutes example.

Get refreshables with their 'capacity' and 'group' expanded example

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/capacities/{capacityId}/refreshables

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "name": "SalesMarketing",
      "kind": "Dataset",
      "startTime": "2017-06-13T09:25:43.153Z",
      "endTime": "2017-06-19T11:22:32.445Z",
      "refreshCount": 22,
      "refreshFailures": 0,
      "averageDuration": 289.3814,
      "medianDuration": 268.6245,
      "refreshesPerDay": 11,
      "lastRefresh": {
        "refreshType": "ViaApi",
        "startTime": "2017-06-13T09:25:43.153Z",
        "endTime": "2017-06-13T09:31:43.153Z",
        "status": "Completed",
        "requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1"
      },
      "refreshSchedule": {
        "days": [
          "Sunday",
          "Friday",
          "Saturday"
        ],
        "times": [
          "05:00",
          "11:30",
          "17:30",
          "23:00"
        ],
        "enabled": true,
        "localTimeZoneId": "UTC",
        "notifyOption": "MailOnFailure"
      },
      "configuredBy": [
        "john@contoso.com"
      ]
    }
  ]
}

Get refreshables, filtering for an average refresh duration of greater than 30 minutes example.

Sample Request

GET https://api.powerbi.com/v1.0/myorg/capacities/{capacityId}/refreshables?$filter=averageDuration gt 1800

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "name": "SalesMarketing",
      "kind": "Dataset",
      "startTime": "2017-06-13T09:25:43.153Z",
      "endTime": "2017-06-19T11:22:32.445Z",
      "refreshCount": 22,
      "refreshFailures": 0,
      "averageDuration": 3289.3814,
      "medianDuration": 2268.6245,
      "refreshesPerDay": 11,
      "lastRefresh": {
        "refreshType": "ViaApi",
        "startTime": "2017-06-13T09:25:43.153Z",
        "endTime": "2017-06-13T09:58:05.221Z",
        "status": "Completed",
        "requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1"
      },
      "refreshSchedule": {
        "days": [
          "Sunday",
          "Friday",
          "Saturday"
        ],
        "times": [
          "05:00",
          "11:30",
          "17:30",
          "23:00"
        ],
        "enabled": true,
        "localTimeZoneId": "UTC",
        "notifyOption": "MailOnFailure"
      },
      "configuredBy": [
        "john@contoso.com"
      ]
    }
  ]
}

Get refreshables with their 'capacity' and 'group' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/capacities/{capacityId}/refreshables?$expand=capacity,group

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "name": "SalesMarketing",
      "kind": "Dataset",
      "startTime": "2017-06-13T09:25:43.153Z",
      "endTime": "2017-06-19T11:22:32.445Z",
      "refreshCount": 22,
      "refreshFailures": 0,
      "averageDuration": 289.3814,
      "medianDuration": 268.6245,
      "refreshesPerDay": 11,
      "lastRefresh": {
        "refreshType": "ViaApi",
        "startTime": "2017-06-13T09:25:43.153Z",
        "endTime": "2017-06-13T09:31:43.153Z",
        "status": "Completed",
        "requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1"
      },
      "refreshSchedule": {
        "days": [
          "Sunday",
          "Friday",
          "Saturday"
        ],
        "times": [
          "05:00",
          "11:30",
          "17:30",
          "23:00"
        ],
        "enabled": true,
        "localTimeZoneId": "UTC",
        "notifyOption": "MailOnFailure"
      },
      "configuredBy": [
        "john@contoso.com"
      ],
      "capacity": {
        "id": "0f084df7-c13d-451b-af5f-ed0c466403b2",
        "displayName": "MyCapacity",
        "sku": "A1"
      },
      "group": {
        "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
        "name": "SalesMarketing"
      }
    }
  ]
}

Definitionen

Name	Beschreibung
Capacity	Eine Power BI-Kapazität
CapacityState	Der Kapazitätsstatus
capacityUserAccessRight	Das Zugriffsrecht, das der Benutzer auf die Kapazität hat
days	Die Tage, an denen die Aktualisierung ausgeführt werden soll
Refresh	Ein Power BI-Aktualisierungsverlaufseintrag
Refreshable	Eine Power BI-Aktualisierung ist ein Dataset, das mindestens einmal aktualisiert wurde oder für das ein gültiger Aktualisierungszeitplan vorhanden ist. Wenn ein Dataset keine dieser Bedingungen erfüllt, wird es nicht in der API-Antwort angezeigt. Power BI behält einen siebentägigen Aktualisierungsverlauf für jedes Dataset bei, bis zu maximal sechzig Aktualisierungen.
RefreshableGroup	Eine Power BI-Gruppe, die einem aktualisierbaren Element zugeordnet ist
RefreshableKind	Die aktualisierbare Art
Refreshables	Eine Liste mit power BI-Aktualisierungsfähigen
RefreshAttempt	Power BI führt automatisch mehrere Versuche durch, ein Dataset zu aktualisieren, wenn ein Aktualisierungsfehler auftritt. Dieses Objekt enthält Informationen zu jedem Aktualisierungsversuch.
RefreshAttemptType	Der Typ des Aktualisierungsversuchs.
RefreshSchedule	Ein Power BI-Aktualisierungszeitplan für importiertes Modell
RefreshType	Der Typ der Aktualisierungsanforderung
ScheduleNotifyOption	Die Benachrichtigungsoption beim Beenden einer geplanten Aktualisierung. Dienstprinzipale unterstützen nur den `NoNotification` Wert.
TenantKey	Verschlüsselungsschlüsselinformationen

Capacity

Eine Power BI-Kapazität

Name	Typ	Beschreibung
admins	string[]	Ein Array von Kapazitätsadministratoren
capacityUserAccessRight	capacityUserAccessRight	Das Zugriffsrecht, das ein Benutzer auf die Kapazität hat
displayName	string	Der Anzeigename der Kapazität
id	string	Die Kapazitäts-ID
region	string	Die Azure-Region, in der die Kapazität bereitgestellt wurde
sku	string	Die Kapazitäts-SKU
state	CapacityState	Der Kapazitätsstatus
tenantKey	TenantKey	Verschlüsselungsschlüsselinformationen (gilt nur für Administratorrouten)
tenantKeyId	string	Die ID eines Verschlüsselungsschlüssels (gilt nur für die Administratorroute)

CapacityState

Der Kapazitätsstatus

Name	Typ	Beschreibung
Active	string	Die Kapazität ist einsatzbereit.
Deleted	string	Die Kapazität wurde gelöscht und ist nicht verfügbar.
Deleting	string	Das Löschen der Kapazität wird ausgeführt.
Invalid	string	Die Kapazität kann nicht verwendet werden.
NotActivated	string	Nicht unterstützt
PreSuspended	string	Nicht unterstützt
ProvisionFailed	string	Fehler bei der Bereitstellung der Kapazität
Provisioning	string	Die Aktivierung der Kapazität wird ausgeführt.
Suspended	string	Die Nutzung der Kapazität wird angehalten.
UpdatingSku	string	Eine Änderung der Kapazitäts-SKU wird ausgeführt.

capacityUserAccessRight

Das Zugriffsrecht, das der Benutzer auf die Kapazität hat

Name	Typ	Beschreibung
Admin	string	Der Benutzer verfügt über Administratorrechte für die Kapazität.
Assign	string	Der Benutzer verfügt über Mitwirkender Rechte und kann der Kapazität Arbeitsbereiche zuweisen.
None	string	Der Benutzer hat keinen Zugriff auf die Kapazität.

days

Die Tage, an denen die Aktualisierung ausgeführt werden soll

Name	Typ	Beschreibung
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

Refresh

Ein Power BI-Aktualisierungsverlaufseintrag

Name	Typ	Beschreibung
endTime	string	Das Enddatum und die Uhrzeit der Aktualisierung (kann leer sein, wenn eine Aktualisierung ausgeführt wird)
refreshAttempts	RefreshAttempt[]	Die Liste der Aktualisierungsversuche.
refreshType	RefreshType	Der Typ der Aktualisierungsanforderung
requestId	string	Dies ist der Bezeichner der Aktualisierungsanforderung. Geben Sie diesen Bezeichner in allen Dienstanforderungen an.
serviceExceptionJson	string	Fehlerfehlercode im JSON-Format (leer, wenn kein Fehler)
startTime	string	Startdatum und -uhrzeit der Aktualisierung
status	string	`Unknown` , wenn der Abschlusszustand unbekannt ist oder eine Aktualisierung ausgeführt wird. `Completed` für eine erfolgreich abgeschlossene Aktualisierung. `Failed` für eine nicht erfolgreiche Aktualisierung (`serviceExceptionJson` enthält den Fehlercode). `Disabled` , wenn die Aktualisierung durch eine selektive Aktualisierung deaktiviert wird.

Refreshable

Eine Power BI-Aktualisierung ist ein Dataset, das mindestens einmal aktualisiert wurde oder für das ein gültiger Aktualisierungszeitplan vorhanden ist. Wenn ein Dataset keine dieser Bedingungen erfüllt, wird es nicht in der API-Antwort angezeigt. Power BI behält einen siebentägigen Aktualisierungsverlauf für jedes Dataset bei, bis zu maximal sechzig Aktualisierungen.

Name	Typ	Beschreibung
averageDuration	number	Die durchschnittliche Dauer einer Aktualisierung in Sekunden während des Zeitfensters, für das Aktualisierungsdaten vorhanden sind
capacity	Capacity	Die Kapazität für das aktualisierbare Element
configuredBy	string[]	Die aktualisierbaren Besitzer
endTime	string	Die Endzeit des Fensters, für das Aktualisierungsdaten vorhanden sind
group	RefreshableGroup	Die zugeordnete Gruppe für das aktualisierbare Element
id	string	Die Objekt-ID des aktualisierbaren
kind	RefreshableKind	Die aktualisierbare Art
lastRefresh	Refresh	Der letzte Power BI-Aktualisierungsverlaufseintrag für das aktualisierbare Element
medianDuration	number	Mediandauer in Sekunden einer Aktualisierung innerhalb des Zeitfensters, für das Aktualisierungsdaten vorhanden sind
name	string	Der Anzeigename des aktualisierbaren
refreshCount	integer	Die Anzahl der Aktualisierungen innerhalb des Zeitfensters, für das Aktualisierungsdaten vorhanden sind
refreshFailures	integer	Die Anzahl von Aktualisierungsfehlern innerhalb des Zeitfensters, für das Aktualisierungsdaten vorhanden sind
refreshSchedule	RefreshSchedule	Aktualisierungszeitplan für das aktualisierbare Element
refreshesPerDay	integer	Die Anzahl der Aktualisierungen pro Tag (geplant und bedarfsgesteuert) innerhalb des Zeitfensters, für das Aktualisierungsdaten vorhanden sind
startTime	string	Die Startzeit des Fensters, für das Aktualisierungsdaten vorhanden sind

RefreshableGroup

Eine Power BI-Gruppe, die einem aktualisierbaren Element zugeordnet ist

Name	Typ	Beschreibung
id	string	Arbeitsbereich-ID
name	string	Der Gruppenname

RefreshableKind

Die aktualisierbare Art

Name	Typ	Beschreibung
Dataset	string	Dataset

Refreshables

Eine Liste mit power BI-Aktualisierungsfähigen

Name	Typ	Beschreibung
odata.context	string	OData-Kontext
value	Refreshable[]	Die aktualisierungsfähigen Daten

RefreshAttempt

Power BI führt automatisch mehrere Versuche durch, ein Dataset zu aktualisieren, wenn ein Aktualisierungsfehler auftritt. Dieses Objekt enthält Informationen zu jedem Aktualisierungsversuch.

Name	Typ	Beschreibung
attemptId	integer	Der Index des Aktualisierungsversuchs.
endTime	string	Das Enddatum und die Uhrzeit des Aktualisierungsversuchs. Der Wert ist ungültig, wenn der Aktualisierungsversuch ausgeführt wird.
serviceExceptionJson	string	Fehlerfehlercode im JSON-Format. Void, wenn kein Fehler vorliegt.
startTime	string	Das Startdatum und die Uhrzeit des Aktualisierungsversuchs.
type	RefreshAttemptType	Der Typ des Aktualisierungsversuchs.

RefreshAttemptType

Der Typ des Aktualisierungsversuchs.

Name	Typ	Beschreibung
Data	string	Der Aktualisierungsversuch, Daten in das Dataset zu laden.
Query	string	Der Versuch, Premium-Abfragecaches zu aktualisieren und Dashboard kacheln.u

RefreshSchedule

Ein Power BI-Aktualisierungszeitplan für importiertes Modell

Name	Typ	Beschreibung
NotifyOption	ScheduleNotifyOption	Die Benachrichtigungsoption beim Beenden einer geplanten Aktualisierung. Dienstprinzipale unterstützen nur den `NoNotification` Wert.
days	days[]	Die Tage, an denen die Aktualisierung ausgeführt werden soll
enabled	boolean	Ob die Aktualisierung aktiviert ist
localTimeZoneId	string	Die ID der zu verwendenden Zeitzone. Weitere Informationen finden Sie unter Zeitzoneninformationen.
times	string[]	Die Tageszeiten, zu denen die Aktualisierung ausgeführt werden soll

RefreshType

Der Typ der Aktualisierungsanforderung

Name	Typ	Beschreibung
OnDemand	string	Die Aktualisierung wurde interaktiv über das Power BI-Portal ausgelöst.
OnDemandTraining	string	Die Aktualisierung wurde interaktiv über das Power BI-Portal mit automatischem Aggregationstraining ausgelöst.
Scheduled	string	Die Aktualisierung wurde durch eine Einstellung des Datasetaktualisierungszeitplans ausgelöst.
ViaApi	string	Die Aktualisierung wurde durch einen API-Aufruf ausgelöst.
ViaEnhancedApi	string	Die Aktualisierung wurde durch einen erweiterten Aktualisierungs-REST-API-Aufruf ausgelöst.
ViaXmlaEndpoint	string	Die Aktualisierung wurde über den öffentlichen XMLA-Endpunkt von Power BI ausgelöst.

ScheduleNotifyOption

Die Benachrichtigungsoption beim Beenden einer geplanten Aktualisierung. Dienstprinzipale unterstützen nur den NoNotification Wert.

Name	Typ	Beschreibung
MailOnFailure	string	Bei Einem Aktualisierungsfehler wird eine E-Mail-Benachrichtigung gesendet.
NoNotification	string	Es wird keine Benachrichtigung gesendet.

TenantKey

Verschlüsselungsschlüsselinformationen

Name	Typ	Beschreibung
createdAt	string	Erstellungsdatum und -uhrzeit des Verschlüsselungsschlüssels
id	string	Die ID des Verschlüsselungsschlüssels
isDefault	boolean	Gibt an, ob der Verschlüsselungsschlüssel der Standardschlüssel für den gesamten Mandanten ist. Jede neu erstellte Kapazität erbt den Standardschlüssel.
keyVaultKeyIdentifier	string	Der URI, der den Verschlüsselungsschlüssel in Azure Key Vault eindeutig angibt
name	string	Der Name des Verschlüsselungsschlüssels
updatedAt	string	Datum und Uhrzeit der letzten Aktualisierung des Verschlüsselungsschlüssels

Freigeben über

Capacities - Get Refreshables For Capacity

Erforderlicher Bereich

URI-Parameter

Antworten

Beispiele

Example

Sample Request

Sample Response

Get refreshables, filtering for an average refresh duration of greater than 30 minutes example.

Sample Request

Sample Response

Get refreshables with their 'capacity' and 'group' expanded example

Sample Request

Sample Response

Definitionen

Capacity

CapacityState

capacityUserAccessRight

days

Refresh

Refreshable

RefreshableGroup

RefreshableKind

Refreshables

RefreshAttempt

RefreshAttemptType

RefreshSchedule

RefreshType

ScheduleNotifyOption

TenantKey

Zusätzliche Ressourcen