Admin - Get Refreshables

參考

服務:: Power BI REST APIs

API 版本:: v1.0

傳回容量內組織可重新整理的清單。

Power BI 會保留每個數據集的七天重新整理歷程記錄，最多 60 次重新整理。

權限

用戶必須是網狀架構系統管理員，或使用服務主體進行驗證。
支援委派的許可權。

在服務原始驗證下執行時，應用程式不得在 Azure 入口網站中設定 Power BI 的任何系統管理員同意必要先決條件。

必要範圍

Tenant.Read.All 或 Tenant.ReadWrite.All

只有在透過標準委派的系統管理員存取令牌進行驗證時才相關。使用透過服務主體進行驗證時，不得存在。

局限性

每小時最多 200 個要求。

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

含選擇性參數:

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

URI 參數

名稱	位於	必要	類型	Description
$top	query	True	integer int32	只傳回前 n 個結果。
$expand	query		string	接受以逗號分隔的數據類型清單，這會在響應中內嵌展開。支援 `capacities` 與 `groups`。
$filter	query		string	根據 Odata 篩選查詢參數條件，傳回結果的子集。
$skip	query		integer int32	略過前 n 個結果。搭配 top 來擷取前 1000 個以上的結果。

回應

名稱	類型	Description
200 OK	Refreshables	還行

範例

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

範例要求

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

範例回覆

狀態碼:: 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.

範例要求

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

範例回覆

狀態碼:: 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

範例要求

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

範例回覆

狀態碼:: 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"
      }
    }
  ]
}

定義

名稱	Description
Capacity	Power BI 容量
CapacityState	容量狀態
capacityUserAccessRight	使用者對容量的存取權
days	要執行重新整理的天數
Refresh	Power BI 重新整理記錄專案
Refreshable	Power BI 可重新整理是至少重新整理一次或有效的重新整理排程存在的數據集。如果數據集不符合上述任一條件，則不會顯示在 API 回應中。 Power BI 會保留每個數據集的七天重新整理歷程記錄，最多 60 次重新整理。
RefreshableGroup	與可重新整理項目相關聯的Power BI群組
RefreshableKind	可重新整理的種類
Refreshables	Power BI 可重新整理清單
RefreshAttempt	如果數據集發生重新整理失敗，Power BI 會自動多次嘗試重新整理數據集。此物件包含每個重新整理嘗試的相關信息。
RefreshAttemptType	重新整理嘗試的類型。
RefreshSchedule	匯入模型的 Power BI 重新整理排程
RefreshType	重新整理要求的類型
ScheduleNotifyOption	排程重新整理終止的通知選項。服務主體僅支援 `NoNotification` 值。
TenantKey	加密金鑰資訊

Capacity

Power BI 容量

名稱	類型	Description
admins	string[]	容量管理員的陣列
capacityUserAccessRight	capacityUserAccessRight	使用者對容量的存取權
displayName	string	容量的顯示名稱
id	string	容量標識碼
region	string	布建容量的 Azure 區域
sku	string	容量 SKU
state	CapacityState	容量狀態
tenantKey	TenantKey	加密金鑰資訊（僅適用於系統管理員路由）
tenantKeyId	string	加密金鑰的識別碼（僅適用於系統管理路由）

CapacityState

容量狀態

名稱	類型	Description
Active	string	容量已準備好使用
Deleted	string	容量已刪除且無法使用
Deleting	string	正在刪除容量
Invalid	string	無法使用容量
NotActivated	string	支援
PreSuspended	string	支援
ProvisionFailed	string	容量布建失敗
Provisioning	string	容量的啟用正在進行中
Suspended	string	容量的使用已暫停
UpdatingSku	string	容量 SKU 變更正在進行中

capacityUserAccessRight

使用者對容量的存取權

名稱	類型	Description
Admin	string	使用者具有容量的系統管理員許可權
Assign	string	使用者具有參與者許可權，並可將工作區指派給容量
None	string	用戶無法存取容量

days

要執行重新整理的天數

名稱	類型	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

Refresh

Power BI 重新整理記錄專案

名稱	類型	Description
endTime	string	重新整理的結束日期和時間（如果重新整理正在進行中，可能是空的）
refreshAttempts	RefreshAttempt[]	重新整理嘗試清單。
refreshType	RefreshType	重新整理要求的類型
requestId	string	重新整理要求的標識碼。在所有服務要求中提供此標識碼。
serviceExceptionJson	string	JSON 格式的失敗錯誤碼（如果沒有錯誤則為空白）
startTime	string	重新整理的開始日期和時間
status	string	如果完成狀態未知或重新整理正在進行中，`Unknown`。 `Completed` 成功完成的重新整理。 `Failed` 失敗的重新整理（`serviceExceptionJson` 將包含錯誤碼）。如果選擇性重新整理已停用重新整理，`Disabled`。

Refreshable

Power BI 可重新整理是至少重新整理一次或有效的重新整理排程存在的數據集。如果數據集不符合上述任一條件，則不會顯示在 API 回應中。 Power BI 會保留每個數據集的七天重新整理歷程記錄，最多 60 次重新整理。

名稱	類型	Description
averageDuration	number	重新整理數據的時間範圍期間，重新整理的平均持續時間，以秒為單位
capacity	Capacity	可重新整理專案的容量
configuredBy	string[]	可重新整理的擁有者
endTime	string	重新整理資料存在之視窗的結束時間
group	RefreshableGroup	可重新整理項目的相關聯群組
id	string	可重新整理的物件標識碼
kind	RefreshableKind	可重新整理的種類
lastRefresh	Refresh	可重新整理項目的最後一個 Power BI 重新整理記錄專案
medianDuration	number	重新整理數據存在的時間範圍內重新整理的秒數中位數
name	string	可重新整理的顯示名稱
refreshCount	integer	重新整理數據存在的時間範圍內重新整理次數
refreshFailures	integer	重新整理數據存在的時間範圍內重新整理失敗次數
refreshSchedule	RefreshSchedule	可重新整理專案的重新整理排程
refreshesPerDay	integer	在重新整理數據存在的時間範圍內，每天重新整理次數（已排程和隨選）
startTime	string	重新整理資料所在的視窗開始時間

RefreshableGroup

與可重新整理項目相關聯的Power BI群組

名稱	類型	Description
id	string	工作區標識碼
name	string	組名

RefreshableKind

可重新整理的種類

名稱	類型	Description
Dataset	string	數據

Refreshables

Power BI 可重新整理清單

名稱	類型	Description
odata.context	string	OData 內容
value	Refreshable[]	可重新整理的

RefreshAttempt

如果數據集發生重新整理失敗，Power BI 會自動多次嘗試重新整理數據集。此物件包含每個重新整理嘗試的相關信息。

名稱	類型	Description
attemptId	integer	重新整理嘗試的索引。
endTime	string	重新整理嘗試的結束日期和時間。如果重新整理嘗試正在進行中，此值會是 void。
serviceExceptionJson	string	JSON 格式的錯誤碼失敗。如果沒有任何錯誤，則為 Void。
startTime	string	重新整理嘗試的開始日期和時間。
type	RefreshAttemptType	重新整理嘗試的類型。

RefreshAttemptType

重新整理嘗試的類型。

名稱	類型	Description
Data	string	重新整理嘗試將數據載入數據集。
Query	string	嘗試重新整理進階查詢快取和儀錶板磚.u

RefreshSchedule

匯入模型的 Power BI 重新整理排程

名稱	類型	Description
NotifyOption	ScheduleNotifyOption	排程重新整理終止的通知選項。服務主體僅支援 `NoNotification` 值。
days	days[]	要執行重新整理的天數
enabled	boolean	是否啟用重新整理
localTimeZoneId	string	要使用的時區標識碼。如需詳細資訊，請參閱時區資訊。
times	string[]	執行重新整理的一天時間

RefreshType

重新整理要求的類型

名稱	類型	Description
OnDemand	string	重新整理是透過Power BI入口網站以互動方式觸發的
OnDemandTraining	string	重新整理是透過Power BI入口網站以互動方式觸發的自動匯總訓練
Scheduled	string	重新整理是由數據集重新整理排程設定所觸發
ViaApi	string	重新整理是由 API 呼叫所觸發
ViaEnhancedApi	string	重新整理是由增強式重新整理 REST API 呼叫所觸發
ViaXmlaEndpoint	string	重新整理是透過Power BI公用 XMLA 端點觸發的

ScheduleNotifyOption

排程重新整理終止的通知選項。服務主體僅支援 NoNotification 值。

名稱	類型	Description
MailOnFailure	string	重新整理失敗時會傳送郵件通知
NoNotification	string	不會傳送通知

TenantKey

加密金鑰資訊

名稱	類型	Description
createdAt	string	加密金鑰的建立日期和時間
id	string	加密金鑰的識別碼
isDefault	boolean	加密金鑰是否為整個租用戶的預設金鑰。任何新建立的容量都會繼承預設密鑰。
keyVaultKeyIdentifier	string	唯一指定 Azure Key Vault 中加密金鑰的 URI
name	string	加密金鑰的名稱
updatedAt	string	加密金鑰的上次更新日期和時間

共用方式為

Admin - Get Refreshables

權限

必要範圍

局限性

URI 參數

回應

範例

Example

範例要求

範例回覆

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

範例要求

範例回覆

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

範例要求

範例回覆

定義

Capacity

CapacityState

capacityUserAccessRight

days

Refresh

Refreshable

RefreshableGroup

RefreshableKind

Refreshables

RefreshAttempt

RefreshAttemptType

RefreshSchedule

RefreshType

ScheduleNotifyOption

TenantKey

其他資源