Capacities - Get Refreshables For Capacity

Ссылка

Service:: Power BI REST APIs

API Version:: v1.0

Возвращает список обновляемых объектов для указанной емкости, к которым у пользователя есть доступ.

Power BI сохраняет семидневный журнал обновлений для каждого набора данных, не более шестидесяти обновлений.

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

Capacity.Read.All или Capacity.ReadWrite.All

GET https://api.powerbi.com/v1.0/myorg/capacities/{capacityId}/refreshables?$top={$top}

With optional parameters:

GET https://api.powerbi.com/v1.0/myorg/capacities/{capacityId}/refreshables?$expand={$expand}&$filter={$filter}&$top={$top}&$skip={$skip}

Параметры URI

Имя	В	Обязательно	Тип	Описание
capacityId	path	True	string uuid	Идентификатор емкости
$top	query	True	integer int32	Возвращает только первые n результатов.
$expand	query		string	Принимает разделенный запятыми список типов данных, который будет развернут в ответе. Поддерживает `capacities` и `groups`.
$filter	query		string	Фильтрует результаты по логическому условию
$skip	query		integer int32	Пропускает первые n результатов. Используйте с top для получения результатов после первых 1000.

Ответы

Имя	Тип	Описание
200 OK	Refreshables	ОК

Примеры

Example

Get refreshables, filtering for an average refresh duration of greater than 30 minutes example.

Get refreshables with their 'capacity' and 'group' expanded example

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/capacities/{capacityId}/refreshables

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "name": "SalesMarketing",
      "kind": "Dataset",
      "startTime": "2017-06-13T09:25:43.153Z",
      "endTime": "2017-06-19T11:22:32.445Z",
      "refreshCount": 22,
      "refreshFailures": 0,
      "averageDuration": 289.3814,
      "medianDuration": 268.6245,
      "refreshesPerDay": 11,
      "lastRefresh": {
        "refreshType": "ViaApi",
        "startTime": "2017-06-13T09:25:43.153Z",
        "endTime": "2017-06-13T09:31:43.153Z",
        "status": "Completed",
        "requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1"
      },
      "refreshSchedule": {
        "days": [
          "Sunday",
          "Friday",
          "Saturday"
        ],
        "times": [
          "05:00",
          "11:30",
          "17:30",
          "23:00"
        ],
        "enabled": true,
        "localTimeZoneId": "UTC",
        "notifyOption": "MailOnFailure"
      },
      "configuredBy": [
        "john@contoso.com"
      ]
    }
  ]
}

Get refreshables, filtering for an average refresh duration of greater than 30 minutes example.

Sample Request

GET https://api.powerbi.com/v1.0/myorg/capacities/{capacityId}/refreshables?$filter=averageDuration gt 1800

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "name": "SalesMarketing",
      "kind": "Dataset",
      "startTime": "2017-06-13T09:25:43.153Z",
      "endTime": "2017-06-19T11:22:32.445Z",
      "refreshCount": 22,
      "refreshFailures": 0,
      "averageDuration": 3289.3814,
      "medianDuration": 2268.6245,
      "refreshesPerDay": 11,
      "lastRefresh": {
        "refreshType": "ViaApi",
        "startTime": "2017-06-13T09:25:43.153Z",
        "endTime": "2017-06-13T09:58:05.221Z",
        "status": "Completed",
        "requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1"
      },
      "refreshSchedule": {
        "days": [
          "Sunday",
          "Friday",
          "Saturday"
        ],
        "times": [
          "05:00",
          "11:30",
          "17:30",
          "23:00"
        ],
        "enabled": true,
        "localTimeZoneId": "UTC",
        "notifyOption": "MailOnFailure"
      },
      "configuredBy": [
        "john@contoso.com"
      ]
    }
  ]
}

Get refreshables with their 'capacity' and 'group' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/capacities/{capacityId}/refreshables?$expand=capacity,group

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "name": "SalesMarketing",
      "kind": "Dataset",
      "startTime": "2017-06-13T09:25:43.153Z",
      "endTime": "2017-06-19T11:22:32.445Z",
      "refreshCount": 22,
      "refreshFailures": 0,
      "averageDuration": 289.3814,
      "medianDuration": 268.6245,
      "refreshesPerDay": 11,
      "lastRefresh": {
        "refreshType": "ViaApi",
        "startTime": "2017-06-13T09:25:43.153Z",
        "endTime": "2017-06-13T09:31:43.153Z",
        "status": "Completed",
        "requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1"
      },
      "refreshSchedule": {
        "days": [
          "Sunday",
          "Friday",
          "Saturday"
        ],
        "times": [
          "05:00",
          "11:30",
          "17:30",
          "23:00"
        ],
        "enabled": true,
        "localTimeZoneId": "UTC",
        "notifyOption": "MailOnFailure"
      },
      "configuredBy": [
        "john@contoso.com"
      ],
      "capacity": {
        "id": "0f084df7-c13d-451b-af5f-ed0c466403b2",
        "displayName": "MyCapacity",
        "sku": "A1"
      },
      "group": {
        "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
        "name": "SalesMarketing"
      }
    }
  ]
}

Определения

Имя	Описание
Capacity	Емкость Power BI
CapacityState	Состояние емкости
capacityUserAccessRight	Право доступа, которое пользователь имеет для емкости
days	Дни, в которые выполняется обновление
Refresh	Запись журнала обновлений Power BI
Refreshable	Обновляемый набор данных Power BI — это набор данных, обновляемый по крайней мере один раз или для которого существует допустимое расписание обновления. Если набор данных не соответствует ни один из этих условий, он не будет отображаться в ответе API. Power BI сохраняет семидневный журнал обновлений для каждого набора данных, не более шестидесяти обновлений.
RefreshableGroup	Группа Power BI, связанная с обновляемым элементом
RefreshableKind	Обновляемый тип
Refreshables	Список обновляемых компонентов Power BI
RefreshAttempt	Power BI автоматически выполняет несколько попыток обновления набора данных в случае сбоя обновления. Этот объект содержит сведения о каждой попытке обновления.
RefreshAttemptType	Тип попытки обновления.
RefreshSchedule	Расписание обновления Power BI для импортированной модели
RefreshType	Тип запроса на обновление
ScheduleNotifyOption	Параметр уведомления о завершении запланированного обновления. Субъекты-службы поддерживают `NoNotification` только значение .
TenantKey	Сведения о ключе шифрования

Capacity

Емкость Power BI

Имя	Тип	Описание
admins	string[]	Массив администраторов емкости
capacityUserAccessRight	capacityUserAccessRight	Право доступа пользователя к емкости
displayName	string	Отображаемое имя емкости
id	string	Идентификатор емкости
region	string	Регион Azure, в котором была подготовлена емкость.
sku	string	Номер SKU емкости
state	CapacityState	Состояние емкости
tenantKey	TenantKey	Сведения о ключе шифрования (применяется только к маршрутам администратора)
tenantKeyId	string	Идентификатор ключа шифрования (применимо только к маршруту администратора)

CapacityState

Состояние емкости

Имя	Тип	Описание
Active	string	Емкость готова к использованию
Deleted	string	Емкость была удалена и недоступна
Deleting	string	Выполняется удаление емкости
Invalid	string	Емкость не может быть использована
NotActivated	string	Не поддерживается
PreSuspended	string	Не поддерживается
ProvisionFailed	string	Сбой подготовки емкости
Provisioning	string	Выполняется активация емкости
Suspended	string	Использование емкости приостановлено
UpdatingSku	string	Выполняется изменение номера SKU емкости

capacityUserAccessRight

Право доступа, которое пользователь имеет для емкости

Имя	Тип	Описание
Admin	string	Пользователь имеет права администратора для емкости
Assign	string	Пользователь имеет права участник и может назначать рабочие области емкости
None	string	Пользователь не имеет доступа к емкости

days

Дни, в которые выполняется обновление

Имя	Тип	Описание
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

Refresh

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

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

Refreshable

Обновляемый набор данных Power BI — это набор данных, обновляемый по крайней мере один раз или для которого существует допустимое расписание обновления. Если набор данных не соответствует ни один из этих условий, он не будет отображаться в ответе API. Power BI сохраняет семидневный журнал обновлений для каждого набора данных, не более шестидесяти обновлений.

Имя	Тип	Описание
averageDuration	number	Средняя длительность обновления в секундах в течение периода времени, для которого существуют данные обновления
capacity	Capacity	Емкость обновляемого элемента
configuredBy	string[]	Обновляемые владельцы
endTime	string	Время окончания окна, для которого существуют данные обновления
group	RefreshableGroup	Связанная группа для обновляемого элемента
id	string	Идентификатор обновляемого объекта
kind	RefreshableKind	Обновляемый тип
lastRefresh	Refresh	Последняя запись журнала обновлений Power BI для обновляемого элемента
medianDuration	number	Медианная длительность обновления в секундах в течение периода времени, для которого существуют данные обновления
name	string	Отображаемое имя обновляемого объекта
refreshCount	integer	Количество обновлений в течение временного периода, для которого существуют данные обновления
refreshFailures	integer	Количество сбоев обновления в течение временного периода, для которого существуют данные обновления
refreshSchedule	RefreshSchedule	Расписание обновления обновляемого элемента
refreshesPerDay	integer	Количество обновлений в день (запланированных и по запросу) в течение периода времени, для которого существуют данные обновления
startTime	string	Время начала окна, для которого существуют данные обновления

RefreshableGroup

Группа Power BI, связанная с обновляемым элементом

Имя	Тип	Описание
id	string	идентификатор рабочей области;
name	string	Имя группы

RefreshableKind

Обновляемый тип

Имя	Тип	Описание
Dataset	string	Dataset

Refreshables

Список обновляемых компонентов Power BI

Имя	Тип	Описание
odata.context	string	Контекст OData
value	Refreshable[]	Обновляемые компоненты

RefreshAttempt

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

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

RefreshAttemptType

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

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

RefreshSchedule

Расписание обновления Power BI для импортированной модели

Имя	Тип	Описание
NotifyOption	ScheduleNotifyOption	Параметр уведомления о завершении запланированного обновления. Субъекты-службы поддерживают `NoNotification` только значение .
days	days[]	Дни, в которые выполняется обновление
enabled	boolean	Включено ли обновление
localTimeZoneId	string	Идентификатор используемого часового пояса. Дополнительные сведения см. в разделе Сведения о часовом поясе.
times	string[]	Время суток для выполнения обновления

RefreshType

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

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

ScheduleNotifyOption

Параметр уведомления о завершении запланированного обновления. Субъекты-службы поддерживают NoNotification только значение .

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

TenantKey

Сведения о ключе шифрования

Имя	Тип	Описание
createdAt	string	Дата и время создания ключа шифрования
id	string	Идентификатор ключа шифрования
isDefault	boolean	Указывает, является ли ключ шифрования ключом по умолчанию для всего клиента. Любая только что созданная емкость наследует ключ по умолчанию.
keyVaultKeyIdentifier	string	Универсальный код ресурса (URI), однозначно указывающий ключ шифрования в Azure Key Vault
name	string	Имя ключа шифрования
updatedAt	string	Дата и время последнего обновления ключа шифрования

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

Capacities - Get Refreshables For Capacity

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

Параметры URI

Ответы

Примеры

Example

Sample Request

Sample Response

Get refreshables, filtering for an average refresh duration of greater than 30 minutes example.

Sample Request

Sample Response

Get refreshables with their 'capacity' and 'group' expanded example

Sample Request

Sample Response

Определения

Capacity

CapacityState

capacityUserAccessRight

days

Refresh

Refreshable

RefreshableGroup

RefreshableKind

Refreshables

RefreshAttempt

RefreshAttemptType

RefreshSchedule

RefreshType

ScheduleNotifyOption

TenantKey

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