Datasets - Refresh Dataset In Group

Ссылка

Service:: Power BI REST APIs

API Version:: v1.0

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

Разрешения

Этот вызов API может вызываться профилем субъекта-службы. Дополнительные сведения см. в статье Профили субъектов-служб в Power BI Embedded.

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

Dataset.ReadWrite.All

Ограничения

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

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

Параметры URI

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

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

Имя	Обязательно	Тип	Описание
notifyOption	True	NotifyOption	Параметры уведомлений по почте. Этот параметр не применяется к расширенным обновлениям или операциям API с субъектом-службой.
applyRefreshPolicy		boolean	Определение того, применяется ли политика
commitMode		DatasetCommitMode	Определяет, будут ли объекты зафиксированы пакетами или только по завершении
effectiveDate		string	Если применяется политика добавочного обновления, `effectiveDate` параметр переопределяет текущую дату.
maxParallelism		integer	Максимальное число потоков, в которых выполняются команды параллельной обработки.
objects		DatasetRefreshObjects[]	Массив объектов для обработки
retryCount		integer	Количество повторных попыток операции перед сбоем
type		DatasetRefreshType	Тип выполняемой обработки

Ответы

Имя	Тип	Описание
202 Accepted		Принято Headers x-ms-request-id: string Location: string

Имя

Тип

Описание

202 Accepted

Принято

Headers

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

Примеры

Example of refreshing a dataset

Example of refreshing one partition

Example of refreshing a dataset

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes

Request Body

{
  "notifyOption": "MailOnFailure",
  "retryCount": 3
}

Sample Response

Status code:: 202

x-ms-request-id: 87f31ef7-1e3a-4006-9b0b-191693e79e9e
Location: https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes/87f31ef7-1e3a-4006-9b0b-191693e79e9e

Example of refreshing one partition

Sample Request

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

Request Body

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

Sample Response

Status code:: 200

Определения

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

DatasetCommitMode

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

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

DatasetRefreshObjects

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

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

DatasetRefreshRequest

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

Имя	Тип	Описание
applyRefreshPolicy	boolean	Определение того, применяется ли политика
commitMode	DatasetCommitMode	Определяет, будут ли объекты зафиксированы пакетами или только по завершении
effectiveDate	string	Если применяется политика добавочного обновления, `effectiveDate` параметр переопределяет текущую дату.
maxParallelism	integer	Максимальное число потоков, в которых выполняются команды параллельной обработки.
notifyOption	NotifyOption	Параметры уведомлений по почте. Этот параметр не применяется к расширенным обновлениям или операциям API с субъектом-службой.
objects	DatasetRefreshObjects[]	Массив объектов для обработки
retryCount	integer	Количество повторных попыток операции перед сбоем
type	DatasetRefreshType	Тип выполняемой обработки

DatasetRefreshType

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

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

NotifyOption

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

Имя	Тип	Описание
MailOnCompletion	string	По завершении обновления будет отправлено почтовое уведомление об успешном выполнении или сбое.
MailOnFailure	string	При сбое обновления будет отправлено уведомление по почте.
NoNotification	string	Уведомления не отправляются

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

Datasets - Refresh Dataset In Group

Разрешения

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

Ограничения

Параметры URI

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

Ответы

Примеры

Example of refreshing a dataset

Sample Request

Sample Response

Example of refreshing one partition

Sample Request

Sample Response

Определения

DatasetCommitMode

DatasetRefreshObjects

DatasetRefreshRequest

DatasetRefreshType

NotifyOption

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