Datasets - Get Refresh History In Group

  • 參考
Service:
Power BI REST APIs
API Version:
v1.0

從指定的工作區傳回指定資料集的重新整理歷程記錄。

權限

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

必要範圍

Dataset.ReadWrite.All 或 Dataset.Read.All

限制

不會傳回 OneDrive 重新整理歷程記錄。 

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/{datasetId}/refreshes
With optional parameters: 
GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/{datasetId}/refreshes?$top={$top}

URI 參數

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

string

資料集識別碼
groupId
 path True

string

uuid

工作區識別碼
$top
 query

integer

重新整理歷程記錄中所要求的專案數目。 如果未提供，則預設值為最後一個可用的 60 個專案。

回應

名稱 類型 Description
200 OK

Refreshes

確定

範例

Completed refresh example
Failed refresh example
In-progress refresh example

Completed refresh example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes?$top=1

Sample Response

Status code:
200 
{
  "value": [
    {
      "refreshType": "ViaApi",
      "startTime": "2017-06-13T09:25:43.153Z",
      "endTime": "2017-06-13T09:31:43.153Z",
      "status": "Completed",
      "requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1",
      "refreshAttempts": [
        {
          "attemptId": 1,
          "startTime": "2017-06-13T09:25:43.153Z",
          "endTime": "2017-06-13T09:31:40.153Z",
          "type": "Data"
        },
        {
          "attemptId": 1,
          "startTime": "2017-06-13T09:31:40.156Z",
          "endTime": "2017-06-13T09:31:43.153Z",
          "type": "Query"
        }
      ]
    }
  ]
}

Failed refresh example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes?$top=1

Sample Response

Status code:
200 
{
  "value": [
    {
      "refreshType": "ViaApi",
      "startTime": "2017-06-13T09:25:43.153Z",
      "endTime": "2017-06-13T09:31:43.153Z",
      "serviceExceptionJson": "{\"errorCode\":\"ModelRefreshFailed_CredentialsNotSpecified\"}",
      "status": "Failed",
      "requestId": "11bf290a-346b-48b7-8973-c5df149337ff",
      "refreshAttempts": [
        {
          "attemptId": 1,
          "startTime": "2017-06-13T09:25:43.153Z",
          "endTime": "2017-06-13T09:31:43.153Z",
          "serviceExceptionJson": "{\"errorCode\":\"ModelRefreshFailed_CredentialsNotSpecified\"}",
          "type": "Data"
        }
      ]
    }
  ]
}

In-progress refresh example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes?$top=1

Sample Response

Status code:
200 
{
  "value": [
    {
      "refreshType": "ViaApi",
      "startTime": "2017-06-13T09:25:43.153Z",
      "status": "Unknown",
      "requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1"
    }
  ]
}

定義

名稱 Description
Refresh

Power BI 重新整理記錄專案
RefreshAttempt

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

重新整理嘗試的類型。
Refreshes

Power BI 重新整理記錄清單的 OData 回應包裝函式
RefreshType

重新整理要求的類型

Refresh

Power BI 重新整理記錄專案

名稱 類型 Description
endTime

string

如果重新整理正在進行中，重新整理 (的結束日期和時間可能是空的)

refreshAttempts

RefreshAttempt[]

重新整理嘗試清單。
refreshType

RefreshType

重新整理要求的類型
requestId

string

重新整理要求的識別碼。 在所有服務要求中提供此識別碼。
serviceExceptionJson

string

JSON 格式的失敗錯誤碼 (如果沒有錯誤) 則為空白
startTime

string

重新整理的開始日期和時間
status

string

  • Unknown 如果完成狀態不明或重新整理正在進行中，則為 。
  • Completed 表示成功完成的重新整理。
  • Failed 若重新整理失敗， (serviceExceptionJson 將包含錯誤碼) 。
  • Disabled 如果選擇性重新整理已停用重新整理，則為 。

RefreshAttempt

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

名稱 類型 Description
attemptId

integer

重新整理嘗試的索引。
endTime

string

重新整理嘗試的結束日期和時間。 如果重新整理嘗試正在進行中，此值會是 void。
serviceExceptionJson

string

JSON 格式的失敗錯誤碼。 如果沒有任何錯誤，則為 Void。
startTime

string

重新整理嘗試的開始日期和時間。
type

RefreshAttemptType

重新整理嘗試的類型。

RefreshAttemptType

重新整理嘗試的類型。

名稱 類型 Description
Data

string

重新整理會嘗試將資料載入資料集。
Query

string

嘗試重新整理進階查詢快取和儀表板磚.u

Refreshes

Power BI 重新整理記錄清單的 OData 回應包裝函式

名稱 類型 Description
odata.context

string

value

Refresh[]

重新整理歷程記錄清單

RefreshType

重新整理要求的類型

名稱 類型 Description
OnDemand

string

重新整理是透過 Power BI 入口網站以互動方式觸發
OnDemandTraining

string

透過 Power BI 入口網站透過自動匯總定型以互動方式觸發重新整理
Scheduled

string

重新整理是由資料集重新整理排程設定所觸發
ViaApi

string

重新整理是由 API 呼叫所觸發
ViaEnhancedApi

string

重新整理是由增強式重新整理 REST API 呼叫所觸發
ViaXmlaEndpoint

string

重新整理是透過 Power BI 公用 XMLA 端點觸發的