Datasets - Get Refresh History In Group

Служба:

Power BI REST APIs

Версия API:

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

С использованием необязательных параметров:

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 minimum: 1	Запрошенный номер записей в журнале обновления. Если это не указано, значение по умолчанию — это последние 60 записей.

Ответы

Имя	Тип	Описание
200 OK	Refreshes	ХОРОШО

Примеры

Completed refresh example

Failed refresh example

In-progress refresh example

Completed refresh example

Образец запроса

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

Пример ответа

Код состояния:

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

Образец запроса

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

Пример ответа

Код состояния:

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

Образец запроса

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

Пример ответа

Код состояния:

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

Object

Запись журнала обновления Power BI

Имя	Тип	Описание
endTime	string (date-time)	Дата окончания и время обновления (может быть пустым, если обновление выполняется) в формате UTC.
refreshAttempts	RefreshAttempt[]	Список попыток обновления.
refreshType	RefreshType	Тип запроса на обновление
requestId	string	Идентификатор запроса на обновление. Укажите этот идентификатор во всех запросах на обслуживание.
serviceExceptionJson	string	Код ошибки сбоя в формате JSON (пустой, если ошибка отсутствует)
startTime	string (date-time)	Дата начала и время обновления в формате UTC.
status	string	Unknown, если состояние завершения неизвестно или выполняется обновление. Completed для успешно завершенного обновления. Failed для неудачного обновления (serviceExceptionJson будет содержать код ошибки). Disabled, если обновление отключено выборочным обновлением.

RefreshAttempt

Object

Power BI автоматически выполняет несколько попыток обновить набор данных при сбое обновления. Этот объект содержит сведения о каждой попытке обновления.

Имя	Тип	Описание
attemptId	integer	Индекс попытки обновления.
endTime	string (date-time)	Дата окончания и время попытки обновления. Значение пусто, если выполняется попытка обновления.
serviceExceptionJson	string	Код ошибки сбоя в формате JSON. Void, если ошибка отсутствует.
startTime	string (date-time)	Дата начала и время попытки обновления.
type	RefreshAttemptType	Тип попытки обновления.

RefreshAttemptType

Перечисление

Тип попытки обновления.

Значение	Описание
Data	Обновление пытается загрузить данные в набор данных.
Query	Попытка обновить кэши запросов класса Premium и плитки панели мониторинга.u

Refreshes

Object

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

Имя	Тип	Описание
@odata.context	string
value	Refresh[]	Список журнала обновлений

RefreshType

Перечисление

Тип запроса на обновление

Значение	Описание
Scheduled	Обновление было активировано параметром расписания обновления набора данных
OnDemand	Обновление было активировано интерактивно с помощью портала Power BI
ViaApi	Обновление было активировано вызовом API
ViaXmlaEndpoint	Обновление было активировано через общедоступную конечную точку XMLA Power BI
ViaEnhancedApi	Обновление было активировано вызовом REST API расширенного обновления
OnDemandTraining	Обновление было активировано интерактивно через портал Power BI с помощью автоматического обучения агрегирования