Datasets - Get Refresh Execution Details

參考

服務:: Power BI REST APIs

API 版本:: v1.0

從 [我的工作區] 傳回指定數據集增強式重新整理作業的執行詳細數據。

必要範圍

Dataset.ReadWrite.All 或 Dataset.Read.All

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

URI 參數

名稱	位於	必要	類型	Description
datasetId	path	True	string (uuid)	數據集標識碼
refreshId	path	True	string (uuid)	重新整理標識碼

回應

名稱	類型	Description
200 OK	DatasetRefreshDetail	確定（當重新整理作業完成或失敗時，會傳回此回應）
202 Accepted	DatasetRefreshDetail	已接受（重新整理作業仍在進行時傳回此回應）

範例

Completed refresh example

Failed refresh example

In progress refresh example

Completed refresh example

範例要求

GET https://api.powerbi.com/v1.0/myorg/datasets/f7fc6510-e151-42a3-850b-d0805a391db0/refreshes/87f31ef7-1e3a-4006-9b0b-191693e79e9e

範例回覆

狀態碼:: 200

{
  "startTime": "2021-12-10T08:40:31.57",
  "endTime": "2021-12-10T08:40:43.87",
  "type": "Full",
  "commitMode": "Transactional",
  "status": "Completed",
  "extendedStatus": "Completed",
  "currentRefreshType": "Full",
  "numberOfAttempts": 0,
  "objects": [
    {
      "table": "DateTableTemplate_78e78207-b3fb-41b5-8b95-e5efca989067",
      "partition": "DateTableTemplate_78e78207-b3fb-41b5-8b95-e5efca989067-ae306fb4-3b7e-4a41-824d-cb3b452fedfc",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_e9d8a66b-4018-4d16-be8c-402b2037c051",
      "partition": "LocalDateTable_e9d8a66b-4018-4d16-be8c-402b2037c051-59bc07f8-85c9-456a-ad36-18e1de4d77ed",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_55935f6b-04d1-4cfe-8856-ed9f9e73ab2e",
      "partition": "LocalDateTable_55935f6b-04d1-4cfe-8856-ed9f9e73ab2e-d95ae7f7-19c9-48a8-9c16-fcab26558bc2",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_ff25f80e-eb04-4229-986d-b40223c04f1c",
      "partition": "LocalDateTable_ff25f80e-eb04-4229-986d-b40223c04f1c-6606fc4c-4cda-49e1-8acd-e55a6ec36cb3",
      "status": "Completed"
    },
    {
      "table": "DimCurrency",
      "partition": "DimCurrency-e5524cc4-a898-433b-91aa-c001b9a6d676",
      "status": "Completed"
    },
    {
      "table": "DimCustomer",
      "partition": "DimCustomer-a31bbd93-e20a-4dee-a33c-7afa27785953",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_fa65a206-f320-4d5d-abcc-1dc0f051ca7d",
      "partition": "LocalDateTable_fa65a206-f320-4d5d-abcc-1dc0f051ca7d-06a48a0a-a32b-48a3-b113-924aafd6363c",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_78a4e1b7-a2e5-4bbf-ab68-7c87961b68a2",
      "partition": "LocalDateTable_78a4e1b7-a2e5-4bbf-ab68-7c87961b68a2-5b3ba715-7c84-4e52-b310-485b93cfbe6d",
      "status": "Completed"
    },
    {
      "table": "DimDate",
      "partition": "DimDate-62e2f91b-53e5-4ed3-8618-fec74dba5e0d",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_e72c294f-0a06-4051-b943-e6bf8389e2c3",
      "partition": "LocalDateTable_e72c294f-0a06-4051-b943-e6bf8389e2c3-891a0e68-d414-4ba3-9c4b-e6f1ec73d4f3",
      "status": "Completed"
    },
    {
      "table": "DimProduct",
      "partition": "DimProduct-3d07cc89-2bd7-4a98-bb37-3368c1562f98",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_e37e4431-8c1a-449c-8796-b704df200a92",
      "partition": "LocalDateTable_e37e4431-8c1a-449c-8796-b704df200a92-8596ebb8-418f-4e50-a921-dac88c6f1339",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_73faffeb-a0c7-4ea1-83dc-530823b0fea0",
      "partition": "LocalDateTable_73faffeb-a0c7-4ea1-83dc-530823b0fea0-13795c4e-708f-4ddc-8ea3-5a2f39ae2253",
      "status": "Completed"
    },
    {
      "table": "DimPromotion",
      "partition": "DimPromotion-21e6c333-430e-4350-8c94-cdceb362c4c7",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_9c19746b-db7d-4b7e-b95d-c66e4b8fefc8",
      "partition": "LocalDateTable_9c19746b-db7d-4b7e-b95d-c66e4b8fefc8-395de144-ad53-41c0-9ec0-68bab6158d99",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_d96435dd-6110-4246-996c-616c96125e71",
      "partition": "LocalDateTable_d96435dd-6110-4246-996c-616c96125e71-891737ee-c46c-4b9f-bfa8-e4555004e20f",
      "status": "Completed"
    },
    {
      "table": "DimSalesTerritory",
      "partition": "DimSalesTerritory-6d88f938-13d5-49f8-899c-d11b3d346ad5",
      "status": "Completed"
    },
    {
      "table": "FactInternetSales",
      "status": "Completed"
    }
  ],
  "refreshAttempts": [
    {
      "attemptId": 1,
      "startTime": "2021-12-10T08:40:31.57",
      "endTime": "2021-12-10T08:40:43.87",
      "type": "Data"
    }
  ]
}

Failed refresh example

範例要求

GET https://api.powerbi.com/v1.0/myorg/datasets/f7fc6510-e151-42a3-850b-d0805a391db0/refreshes/351f7113-59bb-4e5e-8c1e-e15ae7414121

範例回覆

狀態碼:: 200

{
  "startTime": "2021-12-10T08:39:28.517",
  "endTime": "2021-12-10T08:39:30.04",
  "type": "Full",
  "commitMode": "PartialBatch",
  "status": "Failed",
  "extendedStatus": "Failed",
  "currentRefreshType": "Full",
  "numberOfAttempts": 0,
  "messages": [
    {
      "message": "RefreshApiRequest for table refresh using refresh policy must have the property 'CommitMode' = 'Transactional' instead of 'PartialBatch'.",
      "type": "Error"
    }
  ],
  "refreshAttempts": [
    {
      "attemptId": 1,
      "startTime": "2021-12-10T08:39:28.517",
      "endTime": "2021-12-10T08:39:30.04",
      "serviceExceptionJson": "{\"errorCode\":\"ModelRefresh_ShortMessage_ProcessingError\",\"errorDescription\":\"0xC112001C: Expression.Error: Forced Error. . The exception was raised by the IDbCommand interface.\\n0xC112001C: The command has been canceled.. The exception was raised by the IDbCommand interface.\\n0xC11C0006: The current operation was cancelled because another operation in the transaction failed.\\n0xC112001C: The command has been canceled.. The exception was raised by the IDbCommand interface.\\n0xC112001C: The command has been canceled.. The exception was raised by the IDbCommand interface.\\n0xC112001C: The command has been canceled.. The exception was raised by the IDbCommand interface.\"}",
      "type": "Data"
    }
  ]
}

In progress refresh example

範例要求

GET https://api.powerbi.com/v1.0/myorg/datasets/f7fc6510-e151-42a3-850b-d0805a391db0/refreshes/630110f5-8f93-49c2-afee-bfc87072460c

範例回覆

狀態碼:: 202

{
  "startTime": "2021-12-14T03:46:04.833",
  "type": "Full",
  "commitMode": "Transactional",
  "status": "Unknown",
  "extendedStatus": "NotStarted",
  "currentRefreshType": "Full",
  "numberOfAttempts": 0
}

定義

名稱	Description
DatasetRefreshDetail	Power BI 重新整理詳細數據專案
DatasetRefreshDetailCommitMode	判斷物件是否會在批次中認可，或只有在完成時才會認可
DatasetRefreshDetailExtendedStatus	數據集作業詳細狀態
DatasetRefreshDetailStatus	數據集作業一般狀態
DatasetRefreshDetailType	要執行的處理類型
DatasetRefreshObjects	Power BI 數據集重新整理目標
EngineMessage	引擎的錯誤或警告訊息，用於增強式重新整理
RefreshAttempt	如果數據集發生重新整理失敗，Power BI 會自動多次嘗試重新整理數據集。此物件包含每個重新整理嘗試的相關信息。
RefreshAttemptType	重新整理嘗試的類型。
RefreshEngineErrorType	錯誤的類型

DatasetRefreshDetail

Object

Power BI 重新整理詳細數據專案

名稱	類型	Description
commitMode	DatasetRefreshDetailCommitMode	判斷物件是否會在批次中認可，或只有在完成時才會認可
currentRefreshType	DatasetRefreshDetailType	目前反覆專案的處理類型。當 `commitMode` 設定為 `PartialBatch` 時，這會很有用
endTime	string (date-time)	重新整理的結束日期和時間（如果重新整理正在進行中，可能是空的）
extendedStatus	DatasetRefreshDetailExtendedStatus	數據集作業詳細狀態
messages	EngineMessage[]	重新整理要求的引擎錯誤或警告訊息陣列
numberOfAttempts	integer	重新整理要求的嘗試次數
objects	DatasetRefreshObjects[]	重新整理要求中包含的物件陣列
refreshAttempts	RefreshAttempt[]	重新整理嘗試清單。
startTime	string (date-time)	重新整理的開始日期和時間
status	DatasetRefreshDetailStatus	數據集作業一般狀態
type	DatasetRefreshDetailType	要執行的處理類型

DatasetRefreshDetailCommitMode

列舉型別

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

值	Description
PartialBatch	批次認可重新整理作業
Transactional	將整個重新整理作業認可為交易

DatasetRefreshDetailExtendedStatus

列舉型別

數據集作業詳細狀態

值	Description
Cancelled	客戶已取消重新整理作業
Completed	重新整理作業已成功完成
Disabled	選擇性重新整理會停用重新整理作業
Failed	重新整理作業失敗
InProgress	重新整理作業正在進行中
NotStarted	重新整理作業未啟動
TimedOut	重新整理作業逾時
Unknown	完成狀態未知

DatasetRefreshDetailStatus

列舉型別

數據集作業一般狀態

值	Description
Completed	重新整理作業已成功完成
Disabled	選擇性重新整理會停用重新整理作業
Failed	重新整理作業失敗
Unknown	完成狀態未知或重新整理正在進行中

DatasetRefreshDetailType

列舉型別

要執行的處理類型

值	Description
Automatic	如果需要重新整理和重新計算物件，請重新整理並重新計算物件及其所有相依專案。如果分割區處於就緒以外的狀態，則適用。
Calculate	重新計算此物件及其所有相依專案，但前提是需要。這個值不會強制重新計算，但揮發性公式除外。
ClearValues	清除這個物件及其所有相依專案中的值
DataOnly	重新整理此物件中的數據，並清除所有相依專案
Defragment	重組指定數據表中的數據。當數據加入數據表或從數據表中移除數據時，每個數據行的字典可能會因為實際數據行值中不再存在的值而受到污染。重組選項會清除不再使用字典中的值。
Full	針對指定之數據分割、數據表或資料庫中的所有分割區，重新整理數據並重新計算所有相依專案。針對計算分割區，重新計算數據分割及其所有相依專案。

DatasetRefreshObjects

Object

Power BI 數據集重新整理目標

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

EngineMessage

Object

引擎的錯誤或警告訊息，用於增強式重新整理

名稱	類型	Description
code	string	十六進位格式的錯誤碼
message	string	錯誤或警告訊息的文字
type	RefreshEngineErrorType	錯誤的類型

RefreshAttempt

Object

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

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

RefreshAttemptType

列舉型別

重新整理嘗試的類型。

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

RefreshEngineErrorType

列舉型別

錯誤的類型

值	Description
Error	錯誤訊息
Warning	警告訊息

共用方式為

Datasets - Get Refresh Execution Details

必要範圍

URI 參數

回應

範例

Completed refresh example

範例要求

範例回覆

Failed refresh example

範例要求

範例回覆

In progress refresh example

範例要求

範例回覆

定義

DatasetRefreshDetail

DatasetRefreshDetailCommitMode

DatasetRefreshDetailExtendedStatus

DatasetRefreshDetailStatus

DatasetRefreshDetailType

DatasetRefreshObjects

EngineMessage

RefreshAttempt

RefreshAttemptType

RefreshEngineErrorType

其他資源