Admin - Get Refreshables

Referensi

Service:: Power BI REST APIs

API Version:: v1.0

Mengembalikan daftar refreshable untuk organisasi dalam kapasitas.

Power BI mempertahankan riwayat refresh tujuh hari untuk setiap himpunan data, hingga maksimum enam puluh refresh.

Izin

Pengguna harus memiliki hak administrator (seperti Office 365 Administrator Global atau Administrator Layanan Power BI) atau mengautentikasi menggunakan perwakilan layanan.
Izin yang didelegasikan didukung.

Saat berjalan di bawah autentikasi perwakilan layanan, aplikasi tidak boleh memiliki izin admin yang diperlukan untuk Power BI yang diatur di dalam portal Azure.

Cakupan yang Diperlukan

Tenant.Read.All atau Tenant.ReadWrite.All

Hanya relevan saat mengautentikasi melalui token akses admin yang didelegasikan standar. Tidak boleh ada saat autentikasi melalui perwakilan layanan digunakan.

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

With optional parameters:

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
$top	query	True	integer int32	Hanya mengembalikan hasil n pertama.
$expand	query		string	Menerima daftar jenis data yang dipisahkan koma, yang akan diperluas sebaris dalam respons. `capacities` Mendukung dan `groups`.
$filter	query		string	Memfilter hasil berdasarkan kondisi boolean
$skip	query		integer int32	Melompati hasil n pertama. Gunakan dengan atas untuk mengambil hasil di luar 1000 pertama.

Respons

Nama	Jenis	Deskripsi
200 OK	Refreshables	OK

Contoh

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/admin/capacities/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/admin/capacities/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/admin/capacities/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"
      }
    }
  ]
}

Definisi

Nama	Deskripsi
Capacity	Kapasitas Power BI
CapacityState	Status kapasitas
capacityUserAccessRight	Hak akses yang dimiliki pengguna pada kapasitas
days	Hari-hari untuk menjalankan refresh
Refresh	Entri riwayat refresh Power BI
Refreshable	Power BI yang dapat disegarkan adalah himpunan data yang telah di-refresh setidaknya sekali, atau di mana jadwal refresh yang valid ada. Jika himpunan data tidak memenuhi salah satu kondisi ini, maka himpunan data tidak akan muncul dalam respons API. Power BI mempertahankan riwayat refresh tujuh hari untuk setiap himpunan data, hingga maksimum enam puluh refresh.
RefreshableGroup	Grup Power BI yang terkait dengan item yang Dapat Disegarkan
RefreshableKind	Jenis yang dapat di-refresh
Refreshables	Daftar Power BI yang dapat direfresh
RefreshAttempt	Power BI secara otomatis melakukan beberapa upaya untuk merefresh himpunan data jika mengalami kegagalan refresh. Obyek ini memuat informasi tentang setiap upaya penyegaran.
RefreshAttemptType	Jenis upaya refresh.
RefreshSchedule	Jadwal refresh Power BI untuk model yang diimpor
RefreshType	Jenis permintaan refresh
ScheduleNotifyOption	Opsi pemberitahuan tentang penghentian refresh terjadwal. Perwakilan layanan hanya mendukung `NoNotification` nilai .
TenantKey	Informasi kunci enkripsi

Capacity

Kapasitas Power BI

Nama	Jenis	Deskripsi
admins	string[]	Array admin kapasitas
capacityUserAccessRight	capacityUserAccessRight	Hak akses yang dimiliki pengguna pada kapasitas
displayName	string	Nama tampilan kapasitas
id	string	ID kapasitas
region	string	Wilayah Azure tempat kapasitas disediakan
sku	string	SKU kapasitas
state	CapacityState	Status kapasitas
tenantKey	TenantKey	Informasi kunci enkripsi (hanya berlaku untuk rute admin)
tenantKeyId	string	ID kunci enkripsi (hanya berlaku untuk rute admin)

CapacityState

Status kapasitas

Nama	Jenis	Deskripsi
Active	string	Kapasitas siap digunakan
Deleted	string	Kapasitas dihapus dan tidak tersedia
Deleting	string	Penghapusan kapasitas sedang berlangsung
Invalid	string	Kapasitas tidak dapat digunakan
NotActivated	string	Tidak didukung
PreSuspended	string	Tidak didukung
ProvisionFailed	string	Penyediaan kapasitas gagal
Provisioning	string	Aktivasi kapasitas sedang berlangsung
Suspended	string	Penggunaan kapasitas ditangguhkan
UpdatingSku	string	Perubahan SKU kapasitas sedang berlangsung

capacityUserAccessRight

Hak akses yang dimiliki pengguna pada kapasitas

Nama	Jenis	Deskripsi
Admin	string	Pengguna memiliki hak administrator pada kapasitas
Assign	string	Pengguna memiliki hak kontributor dan dapat menetapkan ruang kerja ke kapasitas
None	string	Pengguna tidak memiliki akses ke kapasitas

days

Hari-hari untuk menjalankan refresh

Nama	Jenis	Deskripsi
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

Refresh

Entri riwayat refresh Power BI

Nama	Jenis	Deskripsi
endTime	string	Tanggal akhir dan waktu refresh (mungkin kosong jika refresh sedang berlangsung)
refreshAttempts	RefreshAttempt[]	Daftar upaya refresh.
refreshType	RefreshType	Jenis permintaan refresh
requestId	string	Pengidentifikasi permintaan refresh. Berikan pengidentifikasi ini di semua permintaan layanan.
serviceExceptionJson	string	Kode kesalahan kegagalan dalam format JSON (kosong jika tidak ada kesalahan)
startTime	string	Tanggal dan waktu mulai refresh
status	string	`Unknown` jika status penyelesaian tidak diketahui atau refresh sedang berlangsung. `Completed` untuk refresh yang berhasil diselesaikan. `Failed` untuk refresh yang gagal (`serviceExceptionJson` akan berisi kode kesalahan). `Disabled` jika refresh dinonaktifkan oleh refresh selektif.

Refreshable

Power BI yang dapat disegarkan adalah himpunan data yang telah di-refresh setidaknya sekali, atau di mana jadwal refresh yang valid ada. Jika himpunan data tidak memenuhi salah satu kondisi ini, maka himpunan data tidak akan muncul dalam respons API. Power BI mempertahankan riwayat refresh tujuh hari untuk setiap himpunan data, hingga maksimum enam puluh refresh.

Nama	Jenis	Deskripsi
averageDuration	number	Durasi rata-rata dalam detik refresh selama jendela waktu di mana data refresh ada
capacity	Capacity	Kapasitas untuk item yang dapat di-refresh
configuredBy	string[]	Pemilik yang dapat di-refresh
endTime	string	Waktu akhir jendela tempat data refresh ada
group	RefreshableGroup	Grup terkait untuk item yang dapat disegarkan
id	string	ID objek yang dapat di-refresh
kind	RefreshableKind	Jenis yang dapat di-refresh
lastRefresh	Refresh	Entri riwayat refresh Power BI terakhir untuk item yang dapat direfresh
medianDuration	number	Durasi median dalam hitungan detik refresh dalam jendela waktu tempat data refresh ada
name	string	Nama tampilan yang dapat di-refresh
refreshCount	integer	Jumlah refresh dalam jendela waktu yang data refreshnya ada
refreshFailures	integer	Jumlah kegagalan refresh dalam jendela waktu tempat data refresh ada
refreshSchedule	RefreshSchedule	Jadwal refresh untuk item yang dapat di-refresh
refreshesPerDay	integer	Jumlah refresh per hari (terjadwal dan sesuai permintaan) dalam jendela waktu tempat data refresh ada
startTime	string	Waktu mulai jendela tempat data refresh ada

RefreshableGroup

Grup Power BI yang terkait dengan item yang Dapat Disegarkan

Nama	Jenis	Deskripsi
id	string	ID ruang kerja
name	string	Nama grup

RefreshableKind

Jenis yang dapat di-refresh

Nama	Jenis	Deskripsi
Dataset	string	Himpunan Data

Refreshables

Daftar Power BI yang dapat direfresh

Nama	Jenis	Deskripsi
odata.context	string	Konteks OData
value	Refreshable[]	Yang dapat direfresh

RefreshAttempt

Power BI secara otomatis melakukan beberapa upaya untuk merefresh himpunan data jika mengalami kegagalan refresh. Obyek ini memuat informasi tentang setiap upaya penyegaran.

Nama	Jenis	Deskripsi
attemptId	integer	Indeks upaya refresh.
endTime	string	Tanggal akhir dan waktu upaya refresh. Nilai batal jika upaya refresh sedang berlangsung.
serviceExceptionJson	string	Kode kesalahan kegagalan dalam format JSON. Batalkan jika tidak ada kesalahan.
startTime	string	Tanggal dan waktu mulai upaya refresh.
type	RefreshAttemptType	Jenis upaya refresh.

RefreshAttemptType

Jenis upaya refresh.

Nama	Jenis	Deskripsi
Data	string	Refresh mencoba memuat data ke dalam himpunan data.
Query	string	Upaya untuk menyegarkan cache kueri premium dan petak dasbor.u

RefreshSchedule

Jadwal refresh Power BI untuk model yang diimpor

Nama	Jenis	Deskripsi
NotifyOption	ScheduleNotifyOption	Opsi pemberitahuan tentang penghentian refresh terjadwal. Perwakilan layanan hanya mendukung `NoNotification` nilai .
days	days[]	Hari-hari untuk menjalankan refresh
enabled	boolean	Apakah refresh diaktifkan
localTimeZoneId	string	ID zona waktu yang akan digunakan. Untuk informasi selengkapnya, lihat Info zona waktu.
times	string[]	Waktu hari untuk menjalankan refresh

RefreshType

Jenis permintaan refresh

Nama	Jenis	Deskripsi
OnDemand	string	Refresh dipicu secara interaktif melalui portal Power BI
OnDemandTraining	string	Refresh dipicu secara interaktif melalui portal Power BI dengan pelatihan agregasi otomatis
Scheduled	string	Refresh dipicu oleh pengaturan jadwal refresh himpunan data
ViaApi	string	Refresh dipicu oleh panggilan API
ViaEnhancedApi	string	Refresh dipicu oleh panggilan REST API refresh yang disempurnakan
ViaXmlaEndpoint	string	Refresh dipicu melalui titik akhir XMLA publik Power BI

ScheduleNotifyOption

Opsi pemberitahuan tentang penghentian refresh terjadwal. Perwakilan layanan hanya mendukung NoNotification nilai .

Nama	Jenis	Deskripsi
MailOnFailure	string	Pemberitahuan surat akan dikirim saat kegagalan refresh
NoNotification	string	Tidak ada pemberitahuan yang akan dikirim

TenantKey

Informasi kunci enkripsi

Nama	Jenis	Deskripsi
createdAt	string	Tanggal dan waktu pembuatan kunci enkripsi
id	string	ID kunci enkripsi
isDefault	boolean	Apakah kunci enkripsi adalah kunci default untuk seluruh penyewa. Kapasitas yang baru dibuat mewarisi kunci default.
keyVaultKeyIdentifier	string	URI yang secara unik menentukan kunci enkripsi di Azure Key Vault
name	string	Nama kunci enkripsi
updatedAt	string	Tanggal dan waktu pembaruan terakhir kunci enkripsi

Share via

Admin - Get Refreshables

Izin

Cakupan yang Diperlukan

Parameter URI

Respons

Contoh

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

Definisi

Capacity

CapacityState

capacityUserAccessRight

days

Refresh

Refreshable

RefreshableGroup

RefreshableKind

Refreshables

RefreshAttempt

RefreshAttemptType

RefreshSchedule

RefreshType

ScheduleNotifyOption

TenantKey

Sumber Daya Tambahan: