Capacities - Get Refreshables

Referencia

Service:: Power BI REST APIs

API Version:: v1.0

Devuelve una lista de actualizables para todas las capacidades a las que tiene acceso el usuario.

Power BI conserva un historial de actualización de siete días para cada conjunto de datos, hasta un máximo de sesenta actualizaciones.

Ámbito requerido

Capacity.Read.All o Capacity.ReadWrite.All

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

With optional parameters:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
$top	query	True	integer int32	Devuelve solo los primeros n resultados.
$expand	query		string	Acepta una lista separada por comas de tipos de datos, que se expandirán en línea en la respuesta. Admite `capacity` y `group`.
$filter	query		string	Filtra los resultados en función de una condición booleana.
$skip	query		integer int32	Omite los primeros n resultados. Use con top para capturar resultados más allá de los primeros 1000.

Respuestas

Nombre	Tipo	Description
200 OK	Refreshables	Aceptar

Ejemplos

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/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/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/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"
      }
    }
  ]
}

Definiciones

Nombre	Description
Capacity	Una capacidad de Power BI
CapacityState	El estado de la capacidad
capacityUserAccessRight	El derecho de acceso que tiene el usuario en la capacidad
days	Días en los que se va a ejecutar la actualización
Refresh	Una entrada del historial de actualización de Power BI
Refreshable	Una actualización de Power BI es un conjunto de datos que se ha actualizado al menos una vez o para el que existe una programación de actualización válida. Si un conjunto de datos no cumple ninguna de estas condiciones, no se mostrará en la respuesta de la API. Power BI conserva un historial de actualización de siete días para cada conjunto de datos, hasta un máximo de sesenta actualizaciones.
RefreshableGroup	Un grupo de Power BI asociado a un elemento actualizable
RefreshableKind	El tipo actualizable
Refreshables	Una lista de actualizaciones de Power BI
RefreshAttempt	Power BI realiza automáticamente varios intentos de actualizar un conjunto de datos si experimenta un error de actualización. Este objeto contiene información sobre cada intento de actualización.
RefreshAttemptType	Tipo de intento de actualización.
RefreshSchedule	Una programación de actualización de Power BI para el modelo importado
RefreshType	Tipo de solicitud de actualización
ScheduleNotifyOption	La opción de notificación al finalizar una actualización programada. Las entidades de servicio solo admiten el `NoNotification` valor.
TenantKey	Información de clave de cifrado

Capacity

Una capacidad de Power BI

Nombre	Tipo	Description
admins	string[]	Matriz de administradores de capacidad
capacityUserAccessRight	capacityUserAccessRight	El derecho de acceso que tiene un usuario en la capacidad
displayName	string	Nombre para mostrar de la capacidad
id	string	Identificador de capacidad
region	string	Región de Azure donde se aprovisionó la capacidad
sku	string	SKU de capacidad
state	CapacityState	El estado de la capacidad
tenantKey	TenantKey	Información de clave de cifrado (solo se aplica a las rutas de administración)
tenantKeyId	string	Identificador de una clave de cifrado (solo aplicable a la ruta de administración)

CapacityState

El estado de la capacidad

Nombre	Tipo	Description
Active	string	La capacidad está lista para usarse
Deleted	string	La capacidad se eliminó y no está disponible.
Deleting	string	La eliminación de la capacidad está en curso
Invalid	string	No se puede usar la capacidad
NotActivated	string	No compatible
PreSuspended	string	No compatible
ProvisionFailed	string	Error en el aprovisionamiento de la capacidad
Provisioning	string	La activación de la capacidad está en curso
Suspended	string	El uso de la capacidad se suspende
UpdatingSku	string	Hay un cambio de SKU de capacidad en curso

capacityUserAccessRight

El derecho de acceso que tiene el usuario en la capacidad

Nombre	Tipo	Description
Admin	string	El usuario tiene derechos de administrador en la capacidad
Assign	string	El usuario tiene derechos de colaborador y puede asignar áreas de trabajo a la capacidad.
None	string	El usuario no tiene acceso a la capacidad

days

Días en los que se va a ejecutar la actualización

Nombre	Tipo	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

Refresh

Una entrada del historial de actualización de Power BI

Nombre	Tipo	Description
endTime	string	La fecha y hora de finalización de la actualización (puede estar vacía si hay una actualización en curso)
refreshAttempts	RefreshAttempt[]	Lista de intentos de actualización.
refreshType	RefreshType	Tipo de solicitud de actualización
requestId	string	Identificador de la solicitud de actualización. Proporcione este identificador en todas las solicitudes de servicio.
serviceExceptionJson	string	Código de error en formato JSON (vacío si no hay ningún error)
startTime	string	Fecha y hora de inicio de la actualización
status	string	`Unknown` si el estado de finalización es desconocido o si hay una actualización en curso. `Completed` para una actualización completada correctamente. `Failed` para una actualización incorrecta (`serviceExceptionJson` contendrá el código de error). `Disabled` si la actualización está deshabilitada por una actualización selectiva.

Refreshable

Una actualización de Power BI es un conjunto de datos que se ha actualizado al menos una vez o para el que existe una programación de actualización válida. Si un conjunto de datos no cumple ninguna de estas condiciones, no se mostrará en la respuesta de la API. Power BI conserva un historial de actualización de siete días para cada conjunto de datos, hasta un máximo de sesenta actualizaciones.

Nombre	Tipo	Description
averageDuration	number	Duración media en segundos de una actualización durante el período de tiempo para el que existen datos de actualización.
capacity	Capacity	La capacidad del elemento actualizable
configuredBy	string[]	Propietarios actualizables
endTime	string	Hora de finalización de la ventana para la que existen datos de actualización
group	RefreshableGroup	El grupo asociado para el elemento actualizable
id	string	El identificador de objeto del actualizable
kind	RefreshableKind	El tipo actualizable
lastRefresh	Refresh	La última entrada del historial de actualización de Power BI para el elemento actualizable
medianDuration	number	Duración mediana en segundos de una actualización dentro del período de tiempo para el que existen datos de actualización.
name	string	Nombre para mostrar del actualizable
refreshCount	integer	Número de actualizaciones dentro del período de tiempo para el que existen datos de actualización.
refreshFailures	integer	Número de errores de actualización en el período de tiempo para el que existen datos de actualización.
refreshSchedule	RefreshSchedule	La programación de actualización para el elemento actualizable
refreshesPerDay	integer	Número de actualizaciones por día (programadas y a petición) dentro del período de tiempo para el que existen datos de actualización.
startTime	string	Hora de inicio de la ventana para la que existen datos de actualización

RefreshableGroup

Un grupo de Power BI asociado a un elemento actualizable

Nombre	Tipo	Description
id	string	Identificador del área de trabajo
name	string	El nombre del grupo

RefreshableKind

El tipo actualizable

Nombre	Tipo	Description
Dataset	string	Dataset

Refreshables

Una lista de actualizaciones de Power BI

Nombre	Tipo	Description
odata.context	string	Contexto de OData
value	Refreshable[]	Actualizables

RefreshAttempt

Power BI realiza automáticamente varios intentos de actualizar un conjunto de datos si experimenta un error de actualización. Este objeto contiene información sobre cada intento de actualización.

Nombre	Tipo	Description
attemptId	integer	Índice del intento de actualización.
endTime	string	Fecha y hora de finalización del intento de actualización. El valor es void si el intento de actualización está en curso.
serviceExceptionJson	string	Código de error de error en formato JSON. Void si no hay ningún error.
startTime	string	Fecha y hora de inicio del intento de actualización.
type	RefreshAttemptType	Tipo de intento de actualización.

RefreshAttemptType

Tipo de intento de actualización.

Nombre	Tipo	Description
Data	string	El intento de actualización de cargar datos en el conjunto de datos.
Query	string	El intento de actualizar las cachés de consultas Premium y los iconos del panel.u

RefreshSchedule

Una programación de actualización de Power BI para el modelo importado

Nombre	Tipo	Description
NotifyOption	ScheduleNotifyOption	La opción de notificación al finalizar una actualización programada. Las entidades de servicio solo admiten el `NoNotification` valor.
days	days[]	Días en los que se va a ejecutar la actualización
enabled	boolean	Si la actualización está habilitada
localTimeZoneId	string	Identificador de la zona horaria que se va a usar. Para obtener más información, consulte Información de zona horaria.
times	string[]	Horas del día para ejecutar la actualización

RefreshType

Tipo de solicitud de actualización

Nombre	Tipo	Description
OnDemand	string	La actualización se desencadenó de forma interactiva a través del portal de Power BI.
OnDemandTraining	string	La actualización se desencadenó de forma interactiva a través del portal de Power BI con entrenamiento de agregaciones automáticas
Scheduled	string	La actualización se desencadenó mediante una configuración de programación de actualización del conjunto de datos
ViaApi	string	La actualización se desencadenó mediante una llamada API.
ViaEnhancedApi	string	La actualización se desencadenó mediante una llamada a la API REST de actualización mejorada.
ViaXmlaEndpoint	string	La actualización se desencadenó a través del punto de conexión XMLA público de Power BI

ScheduleNotifyOption

La opción de notificación al finalizar una actualización programada. Las entidades de servicio solo admiten el NoNotification valor.

Nombre	Tipo	Description
MailOnFailure	string	Se enviará una notificación por correo en caso de error de actualización.
NoNotification	string	No se enviará ninguna notificación

TenantKey

Información de clave de cifrado

Nombre	Tipo	Description
createdAt	string	Fecha y hora de creación de la clave de cifrado
id	string	Identificador de la clave de cifrado
isDefault	boolean	Si la clave de cifrado es la clave predeterminada para todo el inquilino. Cualquier capacidad recién creada hereda la clave predeterminada.
keyVaultKeyIdentifier	string	Identificador URI que especifica de forma única la clave de cifrado en Azure Key Vault
name	string	Nombre de la clave de cifrado
updatedAt	string	La última fecha y hora de actualización de la clave de cifrado

Capacities - Get Refreshables

Ámbito requerido

Parámetros de identificador URI

Respuestas

Ejemplos

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

Definiciones

Capacity

CapacityState

capacityUserAccessRight

days

Refresh

Refreshable

RefreshableGroup

RefreshableKind

Refreshables

RefreshAttempt

RefreshAttemptType

RefreshSchedule

RefreshType

ScheduleNotifyOption

TenantKey

Recursos adicionales