Datasets - Refresh Dataset

Service:

Power BI REST APIs

API Version:

v1.0

從 [我的工作區] 觸發指定數據集的重新整理。 只有在設定以外的notifyOption要求承載時，才會觸發增強式重新整理。

必要範圍

Dataset.ReadWrite.All

限制

• 針對共用容量，每天最多可以起始八個要求，包括使用排程重新整理執行的重新整理。
• 針對共用容量，只能在 notifyOption 要求本文中指定。
• 共用容量不支持增強式重新整理。
• 對於增強式重新整理，並非必要專案， notifyOption 而且必須從要求本文中排除。 不過，需要以外的 notifyOption 一或多個參數。
• 針對 Premium 容量，每天的要求上限只會受限於容量中的可用資源。 如果可用的資源多載，重新整理會受到節流處理，直到負載降低為止。 如果節流超過 1 小時，重新整理將會失敗。
  
  

POST https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}/refreshes

URI 參數

名稱	位於	必要	類型	Description
datasetId	path	True	string	數據集標識碼

要求本文

名稱	必要	類型	Description
notifyOption	True	NotifyOption	郵件通知選項。 此參數不適用於使用服務主體的增強式重新整理或 API 作業。
applyRefreshPolicy		boolean	判斷是否已套用原則
commitMode		DatasetCommitMode	判斷物件是否會在批次中認可，或只有在完成時才會認可
effectiveDate		string	如果套用累加式重新整理原則，參數 effectiveDate 會覆寫目前的日期。
maxParallelism		integer	要在其中執行平行處理命令的線程數目上限
objects		DatasetRefreshObjects[]	要處理的物件陣列
retryCount		integer	作業在失敗前會重試的次數
type		DatasetRefreshType	要執行的處理類型

回應

名稱	類型	Description
202 Accepted		已接受 Headers x-ms-request-id: string Location: string

範例

Example of refreshing a dataset

Example of refreshing one partition

Example of refreshing a dataset

Sample Request

POST https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes

Sample Response

Status code:

202

x-ms-request-id: 03f22bb5-2e98-4ae8-8113-329bec3987b1
Location: https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes/03f22bb5-2e98-4ae8-8113-329bec3987b1

Example of refreshing one partition

Sample Request

POST https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes

Request Body

{
  "type": "full",
  "commitMode": "transactional",
  "objects": [
    {
      "table": "Customer",
      "partition": "Robert"
    }
  ],
  "applyRefreshPolicy": "false"
}

Sample Response

Status code:

200

定義

名稱	Description
DatasetCommitMode	判斷物件是否會在批次中認可，或只有在完成時才會認可
DatasetRefreshObjects	Power BI 數據集重新整理目標
DatasetRefreshRequest	Power BI 數據集重新整理要求
DatasetRefreshType	要執行的處理類型
NotifyOption	郵件通知選項

DatasetCommitMode

判斷物件是否會在批次中認可，或只有在完成時才會認可

名稱	類型	Description
PartialBatch	string	以批次方式認可重新整理作業。 使用 partialBatch 模式時，重新整理作業不會發生在交易內。 因此，每個命令都會個別認可，而且在發生失敗時，模型最終可能會處於只載入數據子集的狀態，或數據表保留空白的狀態。 如果您想要保證在發生失敗時保留先前的數據，您應該使用 執行作業 commitMode = transactional.
Transactional	string	將整個重新整理作業認可為交易

DatasetRefreshObjects

Power BI 數據集重新整理目標

名稱	類型	Description
partition	string	要重新整理的數據分割
table	string	要重新整理的數據表

DatasetRefreshRequest

Power BI 數據集重新整理要求

名稱	類型	Description
applyRefreshPolicy	boolean	判斷是否已套用原則
commitMode	DatasetCommitMode	判斷物件是否會在批次中認可，或只有在完成時才會認可
effectiveDate	string	如果套用累加式重新整理原則，參數 effectiveDate 會覆寫目前的日期。
maxParallelism	integer	要在其中執行平行處理命令的線程數目上限
notifyOption	NotifyOption	郵件通知選項。 此參數不適用於使用服務主體的增強式重新整理或 API 作業。
objects	DatasetRefreshObjects[]	要處理的物件陣列
retryCount	integer	作業在失敗前會重試的次數
type	DatasetRefreshType	要執行的處理類型

DatasetRefreshType

要執行的處理類型

名稱	類型	Description
Automatic	string	如果物件需要重新整理與重新計算，請重新整理並重新計算物件，以及其所有的相依性。 若分割區處於 Ready 以外的狀態，則適用。
Calculate	string	重新計算此物件及其所有的相依性，但是只有在需要時進行。 這個值不會強制重新計算，但動態公式除外。
ClearValues	string	清除此物件中的值及其所有相依專案
DataOnly	string	重新整理此物件中的數據，並清除所有相依專案
Defragment	string	重組指定資料表中的資料。 當從資料表中新增或移除資料時，每個資料行字典可能被不再存在於實際資料行值的值所干擾。 重組選項將會清除字典中不再使用的值。
Full	string	在指定分割區、資料表或資料庫中的所有分割區內，重新整理資料並重新計算所有相依性。 若是計算分割區，請重新計算分割區和所有相依性。

NotifyOption

郵件通知選項

名稱	類型	Description
MailOnCompletion	string	郵件通知，指出在重新整理完成時將傳送成功或失敗
MailOnFailure	string	重新整理失敗時會傳送郵件通知
NoNotification	string	不會傳送通知