Datasets - Refresh Dataset In Group
從指定的工作區觸發指定數據集的重新整理。 只有在設定以外的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 |
---|---|---|---|---|
dataset
|
path | True |
string |
數據集標識碼 |
group
|
path | True |
string uuid |
工作區識別碼 |
要求本文
名稱 | 必要 | 類型 | Description |
---|---|---|---|
notifyOption | True |
郵件通知選項。 此參數不適用於使用服務主體的增強式重新整理或 API 作業。 |
|
applyRefreshPolicy |
boolean |
判斷是否已套用原則 |
|
commitMode |
判斷物件是否會以批次方式認可,或只有在完成時才會認可 |
||
effectiveDate |
string |
如果套用累加式重新整理原則, |
|
maxParallelism |
integer |
要在其中執行平行處理命令的線程數目上限 |
|
objects |
要處理的物件陣列 |
||
retryCount |
integer |
作業在失敗前重試的次數 |
|
type |
要執行的處理類型 |
回應
名稱 | 類型 | Description |
---|---|---|
202 Accepted |
已接受 Headers
|
範例
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/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes
{
"notifyOption": "MailOnFailure",
"retryCount": 3
}
Sample Response
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
Sample Request
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"
}
Sample Response
定義
名稱 | Description |
---|---|
Dataset |
判斷物件是否會以批次方式認可,或只有在完成時才會認可 |
Dataset |
Power BI 數據集重新整理目標 |
Dataset |
Power BI 數據集重新整理要求 |
Dataset |
要執行的處理類型 |
Notify |
郵件通知選項 |
DatasetCommitMode
判斷物件是否會以批次方式認可,或只有在完成時才會認可
名稱 | 類型 | Description |
---|---|---|
PartialBatch |
string |
以批次方式認可重新整理作業。 使用 |
Transactional |
string |
將整個重新整理作業認可為交易 |
DatasetRefreshObjects
Power BI 數據集重新整理目標
名稱 | 類型 | Description |
---|---|---|
partition |
string |
要重新整理的數據分割 |
table |
string |
要重新整理的數據表 |
DatasetRefreshRequest
Power BI 數據集重新整理要求
名稱 | 類型 | Description |
---|---|---|
applyRefreshPolicy |
boolean |
判斷是否已套用原則 |
commitMode |
判斷物件是否會以批次方式認可,或只有在完成時才會認可 |
|
effectiveDate |
string |
如果套用累加式重新整理原則, |
maxParallelism |
integer |
要在其中執行平行處理命令的線程數目上限 |
notifyOption |
郵件通知選項。 此參數不適用於使用服務主體的增強式重新整理或 API 作業。 |
|
objects |
要處理的物件陣列 |
|
retryCount |
integer |
作業在失敗前重試的次數 |
type |
要執行的處理類型 |
DatasetRefreshType
要執行的處理類型
名稱 | 類型 | Description |
---|---|---|
Automatic |
string |
如果物件需要重新整理與重新計算,請重新整理並重新計算物件,以及其所有的相依性。 若分割區處於 Ready 以外的狀態,則適用。 |
Calculate |
string |
重新計算此物件及其所有的相依性,但是只有在需要時進行。 此值不會強制重新計算,但變動性公式除外。 |
ClearValues |
string |
清除此物件中的值及其所有相依專案 |
DataOnly |
string |
重新整理此物件中的數據,並清除所有相依專案 |
Defragment |
string |
重組指定資料表中的資料。 當從資料表中新增或移除資料時,每個資料行字典可能被不再存在於實際資料行值的值所干擾。 重組選項將會清除字典中不再使用的值。 |
Full |
string |
在指定分割區、資料表或資料庫中的所有分割區內,重新整理資料並重新計算所有相依性。 若是計算分割區,請重新計算分割區和所有相依性。 |
NotifyOption
郵件通知選項
名稱 | 類型 | Description |
---|---|---|
MailOnCompletion |
string |
指出重新整理完成時將傳送成功或失敗的郵件通知 |
MailOnFailure |
string |
重新整理失敗時,將會傳送郵件通知 |
NoNotification |
string |
不會傳送任何通知 |