共用方式為

Datasets - Refresh Dataset In Group

  • 參考
服務:
Power BI REST APIs
API 版本:
v1.0

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

權限

此 API 呼叫可由服務主體配置檔呼叫。 如需詳細資訊，請參閱：Power BI Embedded中的服務主體配置檔。

必要範圍

Dataset.ReadWrite.All

局限性

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

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

URI 參數

名稱 位於 必要 類型 Description
datasetId
 path True

string

數據集標識碼
groupId
 path True

string

uuid

工作區標識碼

要求本文

名稱 必要 類型 Description
notifyOption True

NotifyOption

郵件通知選項。 此參數不適用於使用服務主體的增強式重新整理或 API 作業。
applyRefreshPolicy

boolean

判斷是否已套用原則
commitMode

DatasetCommitMode

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

string

如果套用累加式重新整理原則，effectiveDate 參數會覆寫目前的日期。
maxParallelism

integer

要在其中執行平行處理命令的線程數目上限
objects

DatasetRefreshObjects[]

要處理的物件陣列
retryCount

integer

作業在失敗前會重試的次數。 暫時的內部錯誤可能會觸發重新整理的重試，即使此參數設定為 0。
type

DatasetRefreshType

要執行的處理類型

回應

名稱 類型 Description
202 Accepted

接受

標題

  • x-ms-request-id: string
  • Location: string

範例

Example of refreshing a dataset
Example of refreshing one partition

Example of refreshing a dataset

範例要求

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes
要求本文
{
  "notifyOption": "MailOnFailure",
  "retryCount": 3
}

範例回覆

狀態碼:
202 
x-ms-request-id: 87f31ef7-1e3a-4006-9b0b-191693e79e9e
Location: https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes/87f31ef7-1e3a-4006-9b0b-191693e79e9e

Example of refreshing one partition

範例要求

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes
要求本文
{
  "type": "full",
  "commitMode": "transactional",
  "objects": [
    {
      "table": "Customer",
      "partition": "Robert"
    }
  ],
  "applyRefreshPolicy": "false"
}

範例回覆

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

作業在失敗前會重試的次數。 暫時的內部錯誤可能會觸發重新整理的重試，即使此參數設定為 0。
type

DatasetRefreshType

要執行的處理類型

DatasetRefreshType

要執行的處理類型

名稱 類型 Description
Automatic

string

如果需要重新整理和重新計算物件，請重新整理並重新計算物件及其所有相依專案。 如果分割區處於就緒以外的狀態，則適用 。
Calculate

string

重新計算此物件及其所有相依專案，但前提是需要。 這個值不會強制重新計算，但揮發性公式除外。
ClearValues

string

清除這個物件及其所有相依專案中的值
DataOnly

string

重新整理此物件中的數據，並清除所有相依專案
Defragment

string

重組指定數據表中的數據。 當數據加入數據表或從數據表中移除數據時，每個數據行的字典可能會因為實際數據行值中不再存在的值而受到污染。 重組選項會清除不再使用字典中的值。
Full

string

針對指定之數據分割、數據表或資料庫中的所有分割區，重新整理數據並重新計算所有相依專案。 針對計算分割區，重新計算數據分割及其所有相依專案。

NotifyOption

郵件通知選項

名稱 類型 Description
MailOnCompletion

string

指出重新整理完成時將傳送成功或失敗的郵件通知
MailOnFailure

string

重新整理失敗時會傳送郵件通知
NoNotification

string

不會傳送通知