Admin - Get Refreshables

Layanan:: Power BI REST APIs

Versi API:: v1.0

Mengembalikan daftar refreshables untuk organisasi dalam kapasitas.

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

Izin

Pengguna harus menjadi administrator Fabric 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 ditetapkan di portal Microsoft 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.

Pembatasan

Maksimum 200 permintaan per jam.

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

Dengan parameter opsional:

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) minimum: 1	Hanya mengembalikan hasil n pertama.
$expand	query		string	Menerima daftar jenis data yang dipisahkan koma, yang akan diperluas sebaris dalam respons. Mendukung `capacities` dan `groups`.
$filter	query		string	Mengembalikan subset hasil berdasarkan kondisi parameter kueri Odata filter.
$skip	query		integer (int32)	Melewati hasil n pertama. Gunakan dengan bagian atas untuk mengambil hasil di luar 1000 pertama.

Respons

Nama	Jenis	Deskripsi
200 OK	Refreshables	OKE

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

Permintaan sampel

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

Respon sampel

Kode status:: 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.

Permintaan sampel

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

Respon sampel

Kode status:: 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

Permintaan sampel

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

Respon sampel

Kode status:: 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 disegarkan 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 refreshables
RefreshAttempt	Power BI secara otomatis melakukan beberapa upaya untuk merefresh himpunan data jika mengalami kegagalan refresh. Objek ini berisi informasi tentang setiap upaya refresh.
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 nilai `NoNotification`.
TenantKey	Informasi kunci enkripsi

Capacity

Objek

Kapasitas Power BI

Nama	Jenis	Deskripsi
admins	string[]	Array admin kapasitas
capacityUserAccessRight	capacityUserAccessRight	Akses yang tepat yang dimiliki pengguna pada kapasitas
displayName	string	Nama tampilan kapasitas
id	string (uuid)	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 (uuid)	ID kunci enkripsi (hanya berlaku untuk rute admin)

CapacityState

Enumerasi

Status kapasitas

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

capacityUserAccessRight

Enumerasi

Hak akses yang dimiliki pengguna pada kapasitas

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

days

Enumerasi

Hari-hari untuk menjalankan refresh

Nilai	Deskripsi
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

Refresh

Objek

Entri riwayat refresh Power BI

Nama	Jenis	Deskripsi
endTime	string (date-time)	Tanggal dan waktu akhir refresh (mungkin kosong jika refresh sedang berlangsung) dalam format UTC.
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 (date-time)	Tanggal mulai dan waktu refresh dalam format UTC.
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

Objek

Power BI yang dapat disegarkan adalah himpunan data yang telah disegarkan 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 yang data refreshnya ada
capacity	Capacity	Kapasitas untuk item yang dapat di-refresh
configuredBy	string[]	Pemilik yang dapat di-refresh
endTime	string (date-time)	Waktu akhir jendela tempat data refresh ada dalam format UTC.
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 tempat data refresh 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 (date-time)	Waktu mulai jendela tempat data refresh ada dalam format UTC.

RefreshableGroup

Objek

Grup Power BI yang terkait dengan item yang Dapat Disegarkan

Nama	Jenis	Deskripsi
id	string (uuid)	ID ruang kerja
name	string	Nama grup

RefreshableKind

Enumerasi

Jenis yang dapat di-refresh

Nilai	Deskripsi
Dataset	Dataset

Refreshables

Objek

Daftar Power BI refreshables

Nama	Jenis	Deskripsi
@odata.context	string	Konteks OData
value	Refreshable[]	Refreshables

RefreshAttempt

Objek

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

Nama	Jenis	Deskripsi
attemptId	integer	Indeks upaya refresh.
endTime	string (date-time)	Tanggal dan waktu akhir upaya refresh. Nilai batal jika upaya refresh sedang berlangsung.
executionMetrics	object[]	Metrik eksekusi mesin Analysis Services yang diambil selama upaya refresh.
serviceExceptionJson	string	Kode kesalahan kegagalan dalam format JSON. Batal jika tidak ada kesalahan.
startTime	string (date-time)	Tanggal mulai dan waktu upaya refresh.
type	RefreshAttemptType	Jenis upaya refresh.

RefreshAttemptType

Enumerasi

Jenis upaya refresh.

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

RefreshSchedule

Objek

Jadwal refresh Power BI untuk model yang diimpor

Nama	Jenis	Deskripsi
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.
notifyOption	ScheduleNotifyOption	Opsi pemberitahuan tentang penghentian refresh terjadwal. Perwakilan layanan hanya mendukung nilai `NoNotification`.
times	string[]	Waktu hari untuk menjalankan refresh

RefreshType

Enumerasi

Jenis permintaan refresh

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

ScheduleNotifyOption

Enumerasi

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

Nilai	Deskripsi
NoNotification	Tidak ada pemberitahuan yang akan dikirim
MailOnFailure	Pemberitahuan email akan dikirim saat kegagalan refresh

TenantKey

Objek

Informasi kunci enkripsi

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanggal dan waktu pembuatan kunci enkripsi
id	string (uuid)	ID kunci enkripsi
isDefault	boolean	Apakah kunci enkripsi adalah kunci default untuk seluruh penyewa. Setiap 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 (date-time)	Tanggal dan waktu pembaruan terakhir kunci enkripsi