Datasets - Get Refresh Execution Details In Group

參考

Service:: Power BI REST APIs

API Version:: v1.0

從指定的工作區傳回指定資料集的增強式重新整理作業執行詳細資料。

權限

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

必要範圍

Dataset.ReadWrite.All 或 Dataset.Read.All

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

URI 參數

名稱	位於	必要	類型	Description
datasetId	path	True	string uuid	資料集識別碼
groupId	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

Sample Request

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

Sample Response

Status code:: 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

Sample Request

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

Sample Response

Status code:: 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

Sample Request

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

Sample Response

Status code:: 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

Power BI 重新整理詳細資料項目目

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

DatasetRefreshDetailCommitMode

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

名稱	類型	Description
PartialBatch	string	批次認可重新整理作業
Transactional	string	將整個重新整理作業認可為交易

DatasetRefreshDetailExtendedStatus

資料集作業詳細狀態

名稱	類型	Description
Cancelled	string	客戶已取消重新整理作業
Completed	string	重新整理作業已順利完成
Disabled	string	選擇性重新整理會停用重新整理作業
Failed	string	重新整理作業失敗
InProgress	string	重新整理作業正在進行中
NotStarted	string	重新整理作業未啟動
TimedOut	string	重新整理作業逾時
Unknown	string	完成狀態不明

DatasetRefreshDetailStatus

資料集作業一般狀態

名稱	類型	Description
Completed	string	重新整理作業已順利完成
Disabled	string	選擇性重新整理會停用重新整理作業
Failed	string	重新整理作業失敗
Unknown	string	完成狀態未知或重新整理正在進行中

DatasetRefreshDetailType

要執行的處理類型

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

DatasetRefreshObjects

Power BI 資料集重新整理目標

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

EngineMessage

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

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

RefreshAttempt

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

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

RefreshAttemptType

重新整理嘗試的類型。

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

RefreshEngineErrorType

錯誤的類型

名稱	類型	Description
Error	string	錯誤訊息
Warning	string	警告訊息

共用方式為

Datasets - Get Refresh Execution Details In Group

權限

必要範圍

URI 參數

回應

範例

Completed refresh example

Sample Request

Sample Response

Failed refresh example

Sample Request

Sample Response

In progress refresh example

Sample Request

Sample Response

定義

DatasetRefreshDetail

DatasetRefreshDetailCommitMode

DatasetRefreshDetailExtendedStatus

DatasetRefreshDetailStatus

DatasetRefreshDetailType

DatasetRefreshObjects

EngineMessage

RefreshAttempt

RefreshAttemptType

RefreshEngineErrorType

其他資源