Admin - Get Refreshables

Odwołanie

Usługa:: Power BI REST APIs

Wersja interfejsu API:: v1.0

Zwraca listę odświeżeń dla organizacji w ramach pojemności.

Usługa Power BI zachowuje siedmiodniową historię odświeżania dla każdego zestawu danych, maksymalnie sześćdziesiąt odświeżeń.

Uprawnienia

Użytkownik musi być administratorem sieci szkieletowej lub uwierzytelniać się przy użyciu jednostki usługi.
Uprawnienia delegowane są obsługiwane.

W przypadku uruchamiania w ramach uwierzytelniania podstawowego usługi aplikacji nie może mieć żadnych premii wymaganych przez administratora dla usługi Power BI ustawionych w witrynie Azure Portal.

Wymagany zakres

Tenant.Read.All lub Tenant.ReadWrite.All

Istotne tylko w przypadku uwierzytelniania za pośrednictwem standardowego delegowanego tokenu dostępu administratora. Nie może być obecny, gdy jest używane uwierzytelnianie za pośrednictwem jednostki usługi.

Ograniczenia

Maksymalna liczba żądań na godzinę wynosi 200.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
$top	query	True	integer int32	Zwraca tylko pierwsze n wyników.
$expand	query		string	Akceptuje rozdzielaną przecinkami listę typów danych, które zostaną rozwinięte w tekście w odpowiedzi. Obsługuje `capacities` i `groups`.
$filter	query		string	Zwraca podzbiór wyników na podstawie warunku parametru zapytania filtru Odata.
$skip	query		integer int32	Pomija pierwsze n wyników. Użyj funkcji z góry, aby pobrać wyniki poza pierwszym 1000.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Refreshables	OK

Przykłady

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

Przykładowe żądanie

GET https://api.powerbi.com/v1.0/myorg/admin/capacities/refreshables

Przykładowa odpowiedź

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

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
      }
    }
  ]
}

Definicje

Nazwa	Opis
Capacity	Pojemność usługi Power BI
CapacityState	Stan pojemności
capacityUserAccessRight	Prawo dostępu, które użytkownik ma w pojemności
days	Dni, w których należy wykonać odświeżanie
Refresh	Wpis historii odświeżania usługi Power BI
Refreshable	Odświeżanie usługi Power BI to zestaw danych, który został odświeżony co najmniej raz lub dla którego istnieje prawidłowy harmonogram odświeżania. Jeśli zestaw danych nie spełnia jednego z tych warunków, nie zostanie on wyświetlony w odpowiedzi interfejsu API. Usługa Power BI zachowuje siedmiodniową historię odświeżania dla każdego zestawu danych, maksymalnie sześćdziesiąt odświeżeń.
RefreshableGroup	Grupa usługi Power BI skojarzona z elementem z możliwością odświeżania
RefreshableKind	Rodzaj odświeżania
Refreshables	Lista odświeżeń usługi Power BI
RefreshAttempt	Usługa Power BI automatycznie podejmuje wiele prób odświeżenia zestawu danych, jeśli wystąpi błąd odświeżania. Ten obiekt zawiera informacje o każdej próbie odświeżenia.
RefreshAttemptType	Typ próby odświeżenia.
RefreshSchedule	Harmonogram odświeżania usługi Power BI dla zaimportowanego modelu
RefreshType	Typ żądania odświeżania
ScheduleNotifyOption	Opcja powiadomienia po zakończeniu zaplanowanego odświeżania. Jednostki usługi obsługują tylko wartość `NoNotification`.
TenantKey	Informacje o kluczu szyfrowania

Capacity

Pojemność usługi Power BI

Nazwa	Typ	Opis
admins	string[]	Tablica administratorów pojemności
capacityUserAccessRight	capacityUserAccessRight	Prawo dostępu, które użytkownik ma w pojemności
displayName	string	Nazwa wyświetlana pojemności
id	string	Identyfikator pojemności
region	string	Region świadczenia usługi Azure, w którym aprowizowano pojemność
sku	string	Jednostka SKU pojemności
state	CapacityState	Stan pojemności
tenantKey	TenantKey	Informacje o kluczu szyfrowania (dotyczy tylko tras administracyjnych)
tenantKeyId	string	Identyfikator klucza szyfrowania (dotyczy tylko trasy administratora)

CapacityState

Stan pojemności

Nazwa	Typ	Opis
Active	string	Pojemność jest gotowa do użycia
Deleted	string	Pojemność została usunięta i jest niedostępna
Deleting	string	Usuwanie pojemności jest w toku
Invalid	string	Nie można użyć pojemności
NotActivated	string	Nieobsługiwane
PreSuspended	string	Nieobsługiwane
ProvisionFailed	string	Aprowizowanie pojemności nie powiodło się
Provisioning	string	Trwa aktywacja pojemności
Suspended	string	Użycie pojemności jest zawieszone
UpdatingSku	string	Trwa zmiana jednostki SKU pojemności

capacityUserAccessRight

Prawo dostępu, które użytkownik ma w pojemności

Nazwa	Typ	Opis
Admin	string	Użytkownik ma uprawnienia administratora do pojemności
Assign	string	Użytkownik ma prawa współautora i może przypisywać obszary robocze do pojemności
None	string	Użytkownik nie ma dostępu do pojemności

days

Dni, w których należy wykonać odświeżanie

Nazwa	Typ	Opis
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

Refresh

Wpis historii odświeżania usługi Power BI

Nazwa	Typ	Opis
endTime	string	Data i godzina zakończenia odświeżania (może być pusta, jeśli trwa odświeżanie)
refreshAttempts	RefreshAttempt[]	Lista prób odświeżenia.
refreshType	RefreshType	Typ żądania odświeżania
requestId	string	Identyfikator żądania odświeżania. Podaj ten identyfikator we wszystkich żądaniach obsługi.
serviceExceptionJson	string	Kod błędu błędu w formacie JSON (pusty, jeśli nie ma błędu)
startTime	string	Data i godzina rozpoczęcia odświeżania
status	string	`Unknown`, jeśli stan ukończenia jest nieznany lub trwa odświeżanie. `Completed` pomyślnego ukończenia odświeżania. `Failed` w przypadku nieudanego odświeżania (`serviceExceptionJson` będzie zawierać kod błędu). `Disabled`, jeśli odświeżanie jest wyłączone przez selektywne odświeżanie.

Refreshable

Odświeżanie usługi Power BI to zestaw danych, który został odświeżony co najmniej raz lub dla którego istnieje prawidłowy harmonogram odświeżania. Jeśli zestaw danych nie spełnia jednego z tych warunków, nie zostanie on wyświetlony w odpowiedzi interfejsu API. Usługa Power BI zachowuje siedmiodniową historię odświeżania dla każdego zestawu danych, maksymalnie sześćdziesiąt odświeżeń.

Nazwa	Typ	Opis
averageDuration	number	Średni czas trwania odświeżania w sekundach w przedziale czasu, dla którego istnieją dane odświeżania
capacity	Capacity	Pojemność elementu z możliwością odświeżania
configuredBy	string[]	Właściciele z możliwością odświeżania
endTime	string	Godzina zakończenia okna, dla którego istnieją dane odświeżania
group	RefreshableGroup	Skojarzona grupa dla elementu z możliwością odświeżania
id	string	Identyfikator obiektu odświeżanego
kind	RefreshableKind	Rodzaj odświeżania
lastRefresh	Refresh	Ostatni wpis historii odświeżania usługi Power BI dla elementu z możliwością odświeżania
medianDuration	number	Mediana czasu trwania w sekundach odświeżania w przedziale czasu, dla którego istnieją dane odświeżania
name	string	Nazwa wyświetlana odświeżanego elementu
refreshCount	integer	Liczba odświeżeń w przedziale czasu, dla którego istnieją dane odświeżania
refreshFailures	integer	Liczba niepowodzeń odświeżania w przedziale czasu, dla którego istnieją dane odświeżania
refreshSchedule	RefreshSchedule	Harmonogram odświeżania elementu z możliwością odświeżania
refreshesPerDay	integer	Liczba odświeżeń dziennie (zaplanowanych i na żądanie) w przedziale czasu, dla którego istnieją dane odświeżania
startTime	string	Godzina rozpoczęcia okna, dla którego istnieją dane odświeżania

RefreshableGroup

Grupa usługi Power BI skojarzona z elementem z możliwością odświeżania

Nazwa	Typ	Opis
id	string	Identyfikator obszaru roboczego
name	string	Nazwa grupy

RefreshableKind

Rodzaj odświeżania

Nazwa	Typ	Opis
Dataset	string	Dataset

Refreshables

Lista odświeżeń usługi Power BI

Nazwa	Typ	Opis
odata.context	string	Kontekst OData
value	Refreshable[]	Odświeżenia

RefreshAttempt

Usługa Power BI automatycznie podejmuje wiele prób odświeżenia zestawu danych, jeśli wystąpi błąd odświeżania. Ten obiekt zawiera informacje o każdej próbie odświeżenia.

Nazwa	Typ	Opis
attemptId	integer	Indeks próby odświeżenia.
endTime	string	Data i godzina zakończenia próby odświeżenia. Wartość jest pusta, jeśli próba odświeżenia jest w toku.
serviceExceptionJson	string	Kod błędu w formacie JSON. Unieważnij, jeśli nie ma błędu.
startTime	string	Data i godzina rozpoczęcia próby odświeżenia.
type	RefreshAttemptType	Typ próby odświeżenia.

RefreshAttemptType

Typ próby odświeżenia.

Nazwa	Typ	Opis
Data	string	Odświeżanie próbuje załadować dane do zestawu danych.
Query	string	Próba odświeżenia pamięci podręcznych zapytań w warstwie Premium i kafelków pulpitu nawigacyjnego.u

RefreshSchedule

Harmonogram odświeżania usługi Power BI dla zaimportowanego modelu

Nazwa	Typ	Opis
NotifyOption	ScheduleNotifyOption	Opcja powiadomienia po zakończeniu zaplanowanego odświeżania. Jednostki usługi obsługują tylko wartość `NoNotification`.
days	days[]	Dni, w których należy wykonać odświeżanie
enabled	boolean	Czy odświeżanie jest włączone
localTimeZoneId	string	Identyfikator strefy czasowej do użycia. Aby uzyskać więcej informacji, zobacz informacje o strefie czasowej.
times	string[]	Czasy dnia do wykonania odświeżania

RefreshType

Typ żądania odświeżania

Nazwa	Typ	Opis
OnDemand	string	Odświeżanie zostało wyzwolone interaktywnie za pośrednictwem portalu usługi Power BI
OnDemandTraining	string	Odświeżanie zostało wyzwolone interaktywnie za pośrednictwem portalu usługi Power BI z automatycznym trenowanie agregacji
Scheduled	string	Odświeżanie zostało wyzwolone przez ustawienie harmonogramu odświeżania zestawu danych
ViaApi	string	Odświeżanie zostało wyzwolone przez wywołanie interfejsu API
ViaEnhancedApi	string	Odświeżanie zostało wyzwolone przez ulepszone wywołanie interfejsu API REST odświeżania
ViaXmlaEndpoint	string	Odświeżanie zostało wyzwolone za pośrednictwem publicznego punktu końcowego XMLA usługi Power BI

ScheduleNotifyOption

Opcja powiadomienia po zakończeniu zaplanowanego odświeżania. Jednostki usługi obsługują tylko wartość NoNotification.

Nazwa	Typ	Opis
MailOnFailure	string	Powiadomienie e-mail zostanie wysłane po niepowodzeniu odświeżania
NoNotification	string	Powiadomienie nie zostanie wysłane

TenantKey

Informacje o kluczu szyfrowania

Nazwa	Typ	Opis
createdAt	string	Data i godzina utworzenia klucza szyfrowania
id	string	Identyfikator klucza szyfrowania
isDefault	boolean	Czy klucz szyfrowania jest kluczem domyślnym dla całej dzierżawy. Każda nowo utworzona pojemność dziedziczy klucz domyślny.
keyVaultKeyIdentifier	string	Identyfikator URI, który jednoznacznie określa klucz szyfrowania w usłudze Azure Key Vault
name	string	Nazwa klucza szyfrowania
updatedAt	string	Data i godzina ostatniej aktualizacji klucza szyfrowania

Udostępnij za pośrednictwem

Admin - Get Refreshables

Uprawnienia

Wymagany zakres

Ograniczenia

Parametry identyfikatora URI

Odpowiedzi

Przykłady

Example

Przykładowe żądanie

Przykładowa odpowiedź

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

Przykładowe żądanie

Przykładowa odpowiedź

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

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Capacity

CapacityState

capacityUserAccessRight

days

Refresh

Refreshable

RefreshableGroup

RefreshableKind

Refreshables

RefreshAttempt

RefreshAttemptType

RefreshSchedule

RefreshType

ScheduleNotifyOption

TenantKey

Dodatkowe zasoby