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 参数

名称 在 必需 类型 说明
datasetId
 path True

string

数据集 ID
groupId
 path True

string

uuid

工作区 ID
$top
 query

integer

刷新历史记录中请求的条目数。 如果未提供，则默认值为最后一个可用的 60 个条目。

响应

名称 类型 说明
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"
    }
  ]
}

定义

名称 说明
Refresh

Power BI 刷新历史记录条目
RefreshAttempt

如果遇到刷新失败，Power BI 会自动多次尝试刷新数据集。 此对象包含有关每次刷新尝试的信息。
RefreshAttemptType

刷新尝试的类型。
Refreshes

Power BI 刷新历史记录列表的 OData 响应包装器
RefreshType

刷新请求的类型

Refresh

Power BI 刷新历史记录条目

名称 类型 说明
endTime

string

如果正在进行刷新，刷新 (的结束日期和时间可能为空)

refreshAttempts

RefreshAttempt[]

刷新尝试列表。
refreshType

RefreshType

刷新请求的类型
requestId

string

刷新请求的标识符。 在所有服务请求中提供此标识符。
serviceExceptionJson

string

如果没有错误) ，JSON 格式的失败错误代码 (为空
startTime

string

刷新的开始日期和时间
status

string

  • Unknown 如果完成状态未知或正在进行刷新，则为 。
  • Completed 表示成功完成的刷新。
  • Failed 刷新失败 (serviceExceptionJson 将包含错误代码) 。
  • Disabled 如果选择性刷新禁用了刷新，则为 。

RefreshAttempt

如果遇到刷新失败，Power BI 会自动多次尝试刷新数据集。 此对象包含有关每次刷新尝试的信息。

名称 类型 说明
attemptId

integer

刷新尝试的索引。
endTime

string

刷新尝试的结束日期和时间。 如果刷新尝试正在进行，则值为 void。
serviceExceptionJson

string

JSON 格式的失败错误代码。 如果没有错误，则为 Void。
startTime

string

刷新尝试的开始日期和时间。
type

RefreshAttemptType

刷新尝试的类型。

RefreshAttemptType

刷新尝试的类型。

名称 类型 说明
Data

string

刷新尝试将数据加载到数据集中。
Query

string

尝试刷新高级查询缓存和仪表板 tiles.u

Refreshes

Power BI 刷新历史记录列表的 OData 响应包装器

名称 类型 说明
odata.context

string

value

Refresh[]

刷新历史记录列表

RefreshType

刷新请求的类型

名称 类型 说明
OnDemand

string

刷新是通过 Power BI 门户以交互方式触发的
OnDemandTraining

string

刷新是通过 Power BI 门户通过自动聚合训练以交互方式触发的
Scheduled

string

刷新是由数据集刷新计划设置触发的
ViaApi

string

刷新是由 API 调用触发的
ViaEnhancedApi

string

刷新是由增强的刷新 REST API 调用触发的
ViaXmlaEndpoint

string

刷新是通过 Power BI 公共 XMLA 终结点触发的