Datasets - Get Refresh History

  • Référence
Service:
Power BI REST APIs
API Version:
v1.0

Retourne l’historique d’actualisation du jeu de données spécifié à partir de Mon espace de travail.

Étendue requise

Dataset.ReadWrite.All ou Dataset.Read.All

Limites

L’historique d’actualisation oneDrive n’est pas retourné.

Il existe toujours entre 20 et 60 entrées d’historique d’actualisation disponibles pour chaque jeu de données, en fonction du nombre d’actualisations au cours des 3 derniers jours.
Les 60 plus récents sont conservés s’ils ont tous moins de 3 jours. Les entrées datant de plus de 3 jours sont supprimées lorsqu’il y a plus de 20 entrées. 

GET https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}/refreshes
With optional parameters: 
GET https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}/refreshes?$top={$top}

Paramètres URI

Nom Dans Obligatoire Type Description
datasetId
 path True

string

ID du jeu de données
$top
 query

integer

Nombre d’entrées demandé dans l’historique d’actualisation. Si elle n’est pas fournie, la valeur par défaut est les 60 dernières entrées disponibles.

Réponses

Nom Type Description
200 OK

Refreshes

Ok

Exemples

Completed refresh example
Failed refresh example
In-progress refresh example

Completed refresh example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes?$top=1

Sample Response

Status code:
200 
{
  "value": [
    {
      "refreshType": "ViaApi",
      "startTime": "2017-06-13T09:25:43.153Z",
      "endTime": "2017-06-13T09:31:43.153Z",
      "status": "Completed",
      "requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1",
      "refreshAttempts": [
        {
          "attemptId": 1,
          "startTime": "2017-06-13T09:25:43.153Z",
          "endTime": "2017-06-13T09:31:40.153Z",
          "type": "Data"
        },
        {
          "attemptId": 1,
          "startTime": "2017-06-13T09:31:40.156Z",
          "endTime": "2017-06-13T09:31:43.153Z",
          "type": "Query"
        }
      ]
    }
  ]
}

Failed refresh example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes?$top=1

Sample Response

Status code:
200 
{
  "value": [
    {
      "refreshType": "ViaApi",
      "startTime": "2017-06-13T09:25:43.153Z",
      "endTime": "2017-06-13T09:31:43.153Z",
      "serviceExceptionJson": "{\"errorCode\":\"ModelRefreshFailed_CredentialsNotSpecified\"}",
      "status": "Failed",
      "requestId": "11bf290a-346b-48b7-8973-c5df149337ff",
      "refreshAttempts": [
        {
          "attemptId": 1,
          "startTime": "2017-06-13T09:25:43.153Z",
          "endTime": "2017-06-13T09:31:43.153Z",
          "serviceExceptionJson": "{\"errorCode\":\"ModelRefreshFailed_CredentialsNotSpecified\"}",
          "type": "Data"
        }
      ]
    }
  ]
}

In-progress refresh example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes?$top=1

Sample Response

Status code:
200 
{
  "value": [
    {
      "refreshType": "ViaApi",
      "startTime": "2017-06-13T09:25:43.153Z",
      "status": "Unknown",
      "requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1"
    }
  ]
}

Définitions

Nom Description
Refresh

Une entrée d’historique d’actualisation Power BI
RefreshAttempt

Power BI effectue automatiquement plusieurs tentatives d’actualisation d’un jeu de données en cas d’échec d’actualisation. Cet objet contient des informations sur chaque tentative d’actualisation.
RefreshAttemptType

Type de tentative d’actualisation.
Refreshes

Wrapper de réponse OData pour une liste d’historique d’actualisation Power BI
RefreshType

Type de demande d’actualisation

Refresh

Une entrée d’historique d’actualisation Power BI

Nom Type Description
endTime

string

Date et heure de fin de l’actualisation (peut être vide si une actualisation est en cours)
refreshAttempts

RefreshAttempt[]

Liste des tentatives d’actualisation.
refreshType

RefreshType

Type de demande d’actualisation
requestId

string

Identificateur de la demande d’actualisation. Fournissez cet identificateur dans toutes les demandes de service.
serviceExceptionJson

string

Code d’erreur d’échec au format JSON (vide si aucune erreur)
startTime

string

Date et heure de début de l’actualisation
status

string

  • Unknown si l’état d’achèvement est inconnu ou si une actualisation est en cours.
  • Completed pour une actualisation réussie.
  • Failed pour une actualisation infructueuse (serviceExceptionJson contient le code d’erreur).
  • Disabled si l’actualisation est désactivée par une actualisation sélective.

RefreshAttempt

Power BI effectue automatiquement plusieurs tentatives d’actualisation d’un jeu de données en cas d’échec d’actualisation. Cet objet contient des informations sur chaque tentative d’actualisation.

Nom Type Description
attemptId

integer

Index de la tentative d’actualisation.
endTime

string

Date et heure de fin de la tentative d’actualisation. La valeur est nulle si la tentative d’actualisation est en cours.
serviceExceptionJson

string

Code d’erreur d’échec au format JSON. Annuler s’il n’y a pas d’erreur.
startTime

string

Date et heure de début de la tentative d’actualisation.
type

RefreshAttemptType

Type de tentative d’actualisation.

RefreshAttemptType

Type de tentative d’actualisation.

Nom Type Description
Data

string

Tentative d’actualisation pour charger des données dans le jeu de données.
Query

string

Tentative d’actualisation des caches de requêtes Premium et des vignettes de tableau de bord.u

Refreshes

Wrapper de réponse OData pour une liste d’historique d’actualisation Power BI

Nom Type Description
odata.context

string

value

Refresh[]

Liste d’historique d’actualisation

RefreshType

Type de demande d’actualisation

Nom Type Description
OnDemand

string

L’actualisation a été déclenchée de manière interactive via le portail Power BI
OnDemandTraining

string

L’actualisation a été déclenchée de manière interactive via le portail Power BI avec l’apprentissage des agrégations automatiques
Scheduled

string

L’actualisation a été déclenchée par un paramètre de planification d’actualisation du jeu de données
ViaApi

string

L’actualisation a été déclenchée par un appel d’API
ViaEnhancedApi

string

L’actualisation a été déclenchée par un appel d’API REST d’actualisation amélioré
ViaXmlaEndpoint

string

L’actualisation a été déclenchée via le point de terminaison XMLA public Power BI