Datasets - Get Refresh Execution Details In Group

Ссылка

Служба:: Power BI REST APIs

Версия API:: 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

Имя	В	Обязательно	Тип	Описание
datasetId	path	True	string uuid	Идентификатор набора данных
groupId	path	True	string uuid	идентификатор рабочей области;
refreshId	path	True	string uuid	Идентификатор обновления

Ответы

Имя	Тип	Описание
200 OK	DatasetRefreshDetail	ОК (этот ответ возвращается после завершения или сбоя операции обновления)
202 Accepted	DatasetRefreshDetail	Принято (этот ответ возвращается, когда операция обновления еще выполняется)

Примеры

Completed refresh example

Failed refresh example

In progress refresh example

Completed refresh example

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

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

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

Код состояния:: 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

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

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

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

Код состояния:: 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

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

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

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

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

{
  "startTime": "2021-12-14T03:46:04.833",
  "type": "Full",
  "commitMode": "Transactional",
  "status": "Unknown",
  "extendedStatus": "NotStarted",
  "currentRefreshType": "Full",
  "numberOfAttempts": 0
}

Определения

Имя	Описание
DatasetRefreshDetail	Запись сведений об обновлении Power BI
DatasetRefreshDetailCommitMode	Определяет, будут ли объекты зафиксированы пакетами или только по завершении.
DatasetRefreshDetailExtendedStatus	Подробное состояние операции с набором данных
DatasetRefreshDetailStatus	Общее состояние операции с набором данных
DatasetRefreshDetailType	Тип выполняемой обработки
DatasetRefreshObjects	Целевой объект обновления набора данных Power BI
EngineMessage	Сообщение об ошибке или предупреждении от обработчика для расширенного обновления
RefreshAttempt	Power BI автоматически выполняет несколько попыток обновления набора данных, если в нем возникает сбой обновления. Этот объект содержит сведения о каждой попытке обновления.
RefreshAttemptType	Тип попытки обновления.
RefreshEngineErrorType	Тип ошибки

DatasetRefreshDetail

Object

Запись сведений об обновлении Power BI

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

Enumeration

Определяет, будут ли объекты зафиксированы пакетами или только по завершении.

Значение	Описание
PartialBatch	Фиксация операции обновления в пакетах
Transactional	Фиксация всей операции обновления в виде транзакции

DatasetRefreshDetailExtendedStatus

Enumeration

Подробное состояние операции с набором данных

Значение	Описание
Cancelled	Операция обновления была отменена клиентом
Completed	Операция обновления успешно завершена
Disabled	Операция обновления отключена выборочным обновлением
Failed	Операция обновления не выполнена
InProgress	Выполняется операция обновления
NotStarted	Операция обновления не запущена
TimedOut	Истекло время ожидания операции обновления
Unknown	Состояние завершения неизвестно

DatasetRefreshDetailStatus

Enumeration

Общее состояние операции с набором данных

Значение	Описание
Completed	Операция обновления успешно завершена
Disabled	Операция обновления отключена выборочным обновлением
Failed	Операция обновления не выполнена
Unknown	Состояние завершения неизвестно или выполняется обновление

DatasetRefreshDetailType

Enumeration

Тип выполняемой обработки

Значение	Описание
Automatic	Если объект необходимо обновить и пересчитать, обновить и пересчитать объект и все его зависимости. Применяется, если секция находится в состоянии, отличном от "Готово".
Calculate	Пересчитать этот объект и все зависимые ресурсы только при необходимости. Это значение не приводит к принудительному пересчету, за исключением изменяемых формул.
ClearValues	Очистка значений в этом объекте и всех его зависимых объектах
DataOnly	Обновление данных в этом объекте и очистка всех зависимых элементов
Defragment	Дефрагментировать данные в указанной таблице. По мере добавления или удаления данных из таблицы словари для каждого столбца могут заполниться значениями, которых на самом деле больше не существует в столбцах. Параметр дефрагментации приведет к очистке более не используемых значений в словарях.
Full	Обновить данные и пересчитать все зависимые объекты для всех секций в указанной секции, таблице или базе данных. Для вычисления секции пересчитать раздел и все его зависимости.

DatasetRefreshObjects

Object

Целевой объект обновления набора данных Power BI

Имя	Тип	Описание
partition	string	Обновляемая секция
table	string	Обновляемая таблица

EngineMessage

Object

Сообщение об ошибке или предупреждении от обработчика для расширенного обновления

Имя	Тип	Описание
code	string	Код ошибки в шестнадцатеричном формате
message	string	Текст сообщения об ошибке или предупреждении
type	RefreshEngineErrorType	Тип ошибки

RefreshAttempt

Object

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

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

RefreshAttemptType

Enumeration

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

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

RefreshEngineErrorType

Enumeration

Тип ошибки

Значение	Описание
Error	Сообщение об ошибке
Warning	Предупреждение

Поделиться через

Datasets - Get Refresh Execution Details In Group

Разрешения

Требуемая область

Параметры URI

Ответы

Примеры

Completed refresh example

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

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

Failed refresh example

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

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

In progress refresh example

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

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

Определения

DatasetRefreshDetail

DatasetRefreshDetailCommitMode

DatasetRefreshDetailExtendedStatus

DatasetRefreshDetailStatus

DatasetRefreshDetailType

DatasetRefreshObjects

EngineMessage

RefreshAttempt

RefreshAttemptType

RefreshEngineErrorType

Дополнительные ресурсы