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

Идентификатор набора данных
groupId
 path True

string

uuid

идентификатор рабочей области;
$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

Оболочка ответа OData для списка журнала обновлений Power BI
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

Попытка обновить кэши запросов уровня "Премиум" и плитки панели мониторинга.u

Refreshes

Оболочка ответа OData для списка журнала обновлений Power BI

Имя Тип Описание
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

Обновление было активировано через общедоступную конечную точку XMLA Power BI.