Datasets - Refresh Dataset

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

Версия API:: v1.0

Активирует обновление для указанного набора данных из "Моя рабочая область". расширенного обновления активируется только в том случае, если заданы полезные данные запроса, отличные от .

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

Dataset.ReadWrite.All

Ограничения

Для общих емкостей можно инициировать не более восьми запросов в день, включая обновления, выполняемые с помощью запланированного обновления.
Для общих емкостей в тексте запроса можно указать только notifyOption.
Расширенное обновление не поддерживается для общих емкостей.
Для расширенного обновления notifyOption не требуется и должен быть исключен из текста запроса. Однако требуются один или несколько параметров, отличных от notifyOption.
Для емкостей Premium максимальные запросы в день ограничены только доступными ресурсами в емкости. Если доступные ресурсы перегружены, обновления регулируются до уменьшения нагрузки. Обновление завершится ошибкой, если регулирование превышает 1 час.

POST https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}/refreshes

Параметры URI

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

Текст запроса

Имя	Обязательно	Тип	Описание
notifyOption	True	NotifyOption	Параметры уведомлений по почте. Этот параметр не применим к расширенным обновлениям или операциям API с субъектом-службой.
applyRefreshPolicy		boolean	Определение того, применяется ли политика или нет
commitMode		DatasetCommitMode	Определяет, будут ли объекты зафиксированы в пакетах или только после завершения
effectiveDate		string (date-time)	Если применяется добавочная политика обновления, параметр `effectiveDate` переопределяет текущую дату.
maxParallelism		integer	Максимальное количество потоков, в которых выполняются команды параллельной обработки
objects		DatasetRefreshObjects[]	Массив объектов для обработки
retryCount		integer	Количество повторных попыток операции перед сбоем. Временные внутренние ошибки могут активировать повторную попытку обновления, даже если для этого параметра задано значение 0.
timeout		string pattern: ^([0-1]?[0-9]\|2[0-3]):[0-5][0-9]:[0-5][0-9]$	Если указана `timeout`, каждая попытка обновления данных в семантической модели будет соответствовать времени ожидания. Обратите внимание, что один запрос на обновление может включать несколько попыток, если указан `retryCount`, что может привести к превышению общего времени ожидания обновления. Например, установка значения `timeout` на 1 час и `retryCount` на 2 может привести к общей продолжительности обновления до 3 часов. Пользователи могут настроить `timeout`, чтобы сократить продолжительность обновления для ускорения обнаружения сбоев или продлить его за пределами по умолчанию 5 часов для более сложных обновлений данных. Однако общая длительность обновления, включая повторные попытки, не может превышать 24 часа.
type		DatasetRefreshType	Тип выполняемой обработки

Ответы

Имя	Тип	Описание
202 Accepted		Принятый Заголовки x-ms-request-id: string Location: string

Имя

Тип

Описание

202 Accepted

Принятый

Заголовки

x-ms-request-id: string
Location: string

Примеры

Example of refreshing a dataset

Example of refreshing one partition

Example of refreshing a dataset

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

POST https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes

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

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

x-ms-request-id: 03f22bb5-2e98-4ae8-8113-329bec3987b1
Location: https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes/03f22bb5-2e98-4ae8-8113-329bec3987b1

Example of refreshing one partition

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

POST https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes

Текст запроса

{
  "type": "full",
  "commitMode": "transactional",
  "objects": [
    {
      "table": "Customer",
      "partition": "Robert"
    }
  ],
  "applyRefreshPolicy": "false",
  "timeout": "05:00:00"
}

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

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

Определения

Имя	Описание
DatasetCommitMode	Определяет, будут ли объекты зафиксированы в пакетах или только после завершения
DatasetRefreshObjects	Целевой объект обновления набора данных Power BI
DatasetRefreshRequest	Запрос на обновление набора данных Power BI
DatasetRefreshType	Тип выполняемой обработки
NotifyOption	Параметры уведомлений по почте

DatasetCommitMode

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

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

Значение Описание

Transactional

Значение	Описание
Transactional	Фиксация всей операции обновления в виде транзакции
PartialBatch	Зафиксируйте операцию обновления в пакетах. При использовании режима `partialBatch` операция обновления не выполняется в транзакции. Следовательно, каждая команда будет зафиксирована по отдельности, и в случае сбоя модель может оказаться в состоянии, в котором загружается только подмножество данных, или таблица остается пустой. Если вы хотите гарантировать сохранение предыдущих данных в случае сбоя, необходимо выполнить операцию с `commitMode = transactional.`

Фиксация всей операции обновления в виде транзакции

PartialBatch

Зафиксируйте операцию обновления в пакетах. При использовании режима partialBatch операция обновления не выполняется в транзакции. Следовательно, каждая команда будет зафиксирована по отдельности, и в случае сбоя модель может оказаться в состоянии, в котором загружается только подмножество данных, или таблица остается пустой. Если вы хотите гарантировать сохранение предыдущих данных в случае сбоя, необходимо выполнить операцию с commitMode = transactional.

DatasetRefreshObjects

Object

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

Имя	Тип	Описание
partition	string	Раздел для обновления
table	string	Таблица для обновления

DatasetRefreshRequest

Object

Запрос на обновление набора данных Power BI

Имя	Тип	Описание
applyRefreshPolicy	boolean	Определение того, применяется ли политика или нет
commitMode	DatasetCommitMode	Определяет, будут ли объекты зафиксированы в пакетах или только после завершения
effectiveDate	string (date-time)	Если применяется добавочная политика обновления, параметр `effectiveDate` переопределяет текущую дату.
maxParallelism	integer	Максимальное количество потоков, в которых выполняются команды параллельной обработки
notifyOption	NotifyOption	Параметры уведомлений по почте. Этот параметр не применим к расширенным обновлениям или операциям API с субъектом-службой.
objects	DatasetRefreshObjects[]	Массив объектов для обработки
retryCount	integer	Количество повторных попыток операции перед сбоем. Временные внутренние ошибки могут активировать повторную попытку обновления, даже если для этого параметра задано значение 0.
timeout	string pattern: ^([0-1]?[0-9]\|2[0-3]):[0-5][0-9]:[0-5][0-9]$	Если указана `timeout`, каждая попытка обновления данных в семантической модели будет соответствовать времени ожидания. Обратите внимание, что один запрос на обновление может включать несколько попыток, если указан `retryCount`, что может привести к превышению общего времени ожидания обновления. Например, установка значения `timeout` на 1 час и `retryCount` на 2 может привести к общей продолжительности обновления до 3 часов. Пользователи могут настроить `timeout`, чтобы сократить продолжительность обновления для ускорения обнаружения сбоев или продлить его за пределами по умолчанию 5 часов для более сложных обновлений данных. Однако общая длительность обновления, включая повторные попытки, не может превышать 24 часа.
type	DatasetRefreshType	Тип выполняемой обработки

DatasetRefreshType

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

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

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

NotifyOption

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

Параметры уведомлений по почте

Значение	Описание
NoNotification	Уведомление не будет отправлено
MailOnFailure	Уведомление по почте будет отправлено при сбое обновления
MailOnCompletion	Уведомление по почте, указывающее на успешность или сбой, будет отправлено при завершении обновления.