Datasets - Get Refresh Execution Details In Group

Référence

Service:: Power BI REST APIs

API Version:: v1.0

Retourne les détails d’exécution d’une opération d’actualisation améliorée pour le jeu de données spécifié à partir de l’espace de travail spécifié.

Autorisations

Cet appel d’API peut être appelé par un profil de principal de service. Pour plus d’informations, consultez Profils de principal de service dans Power BI Embedded.

Étendue requise

Dataset.ReadWrite.All ou Dataset.Read.All

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
datasetId	path	True	string uuid	ID du jeu de données
groupId	path	True	string uuid	L’ID de l’espace de travail
refreshId	path	True	string uuid	ID d’actualisation

Réponses

Nom	Type	Description
200 OK	DatasetRefreshDetail	OK (cette réponse est retournée lorsque l’opération d’actualisation est terminée ou a échoué)
202 Accepted	DatasetRefreshDetail	Accepté (cette réponse est retournée lorsque l’opération d’actualisation est toujours en cours)

Exemples

Completed refresh example

Failed refresh example

In progress refresh example

Completed refresh example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/fdb91b8f-0a9b-44c1-b6c0-0cb185c6ebfb/datasets/f7fc6510-e151-42a3-850b-d0805a391db0/refreshes/87f31ef7-1e3a-4006-9b0b-191693e79e9e

Sample Response

Status code:: 200

{
  "startTime": "2021-12-10T08:40:31.57",
  "endTime": "2021-12-10T08:40:43.87",
  "type": "Full",
  "commitMode": "Transactional",
  "status": "Completed",
  "extendedStatus": "Completed",
  "currentRefreshType": "Full",
  "numberOfAttempts": 0,
  "objects": [
    {
      "table": "DateTableTemplate_78e78207-b3fb-41b5-8b95-e5efca989067",
      "partition": "DateTableTemplate_78e78207-b3fb-41b5-8b95-e5efca989067-ae306fb4-3b7e-4a41-824d-cb3b452fedfc",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_e9d8a66b-4018-4d16-be8c-402b2037c051",
      "partition": "LocalDateTable_e9d8a66b-4018-4d16-be8c-402b2037c051-59bc07f8-85c9-456a-ad36-18e1de4d77ed",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_55935f6b-04d1-4cfe-8856-ed9f9e73ab2e",
      "partition": "LocalDateTable_55935f6b-04d1-4cfe-8856-ed9f9e73ab2e-d95ae7f7-19c9-48a8-9c16-fcab26558bc2",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_ff25f80e-eb04-4229-986d-b40223c04f1c",
      "partition": "LocalDateTable_ff25f80e-eb04-4229-986d-b40223c04f1c-6606fc4c-4cda-49e1-8acd-e55a6ec36cb3",
      "status": "Completed"
    },
    {
      "table": "DimCurrency",
      "partition": "DimCurrency-e5524cc4-a898-433b-91aa-c001b9a6d676",
      "status": "Completed"
    },
    {
      "table": "DimCustomer",
      "partition": "DimCustomer-a31bbd93-e20a-4dee-a33c-7afa27785953",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_fa65a206-f320-4d5d-abcc-1dc0f051ca7d",
      "partition": "LocalDateTable_fa65a206-f320-4d5d-abcc-1dc0f051ca7d-06a48a0a-a32b-48a3-b113-924aafd6363c",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_78a4e1b7-a2e5-4bbf-ab68-7c87961b68a2",
      "partition": "LocalDateTable_78a4e1b7-a2e5-4bbf-ab68-7c87961b68a2-5b3ba715-7c84-4e52-b310-485b93cfbe6d",
      "status": "Completed"
    },
    {
      "table": "DimDate",
      "partition": "DimDate-62e2f91b-53e5-4ed3-8618-fec74dba5e0d",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_e72c294f-0a06-4051-b943-e6bf8389e2c3",
      "partition": "LocalDateTable_e72c294f-0a06-4051-b943-e6bf8389e2c3-891a0e68-d414-4ba3-9c4b-e6f1ec73d4f3",
      "status": "Completed"
    },
    {
      "table": "DimProduct",
      "partition": "DimProduct-3d07cc89-2bd7-4a98-bb37-3368c1562f98",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_e37e4431-8c1a-449c-8796-b704df200a92",
      "partition": "LocalDateTable_e37e4431-8c1a-449c-8796-b704df200a92-8596ebb8-418f-4e50-a921-dac88c6f1339",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_73faffeb-a0c7-4ea1-83dc-530823b0fea0",
      "partition": "LocalDateTable_73faffeb-a0c7-4ea1-83dc-530823b0fea0-13795c4e-708f-4ddc-8ea3-5a2f39ae2253",
      "status": "Completed"
    },
    {
      "table": "DimPromotion",
      "partition": "DimPromotion-21e6c333-430e-4350-8c94-cdceb362c4c7",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_9c19746b-db7d-4b7e-b95d-c66e4b8fefc8",
      "partition": "LocalDateTable_9c19746b-db7d-4b7e-b95d-c66e4b8fefc8-395de144-ad53-41c0-9ec0-68bab6158d99",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_d96435dd-6110-4246-996c-616c96125e71",
      "partition": "LocalDateTable_d96435dd-6110-4246-996c-616c96125e71-891737ee-c46c-4b9f-bfa8-e4555004e20f",
      "status": "Completed"
    },
    {
      "table": "DimSalesTerritory",
      "partition": "DimSalesTerritory-6d88f938-13d5-49f8-899c-d11b3d346ad5",
      "status": "Completed"
    },
    {
      "table": "FactInternetSales",
      "status": "Completed"
    }
  ],
  "refreshAttempts": [
    {
      "attemptId": 1,
      "startTime": "2021-12-10T08:40:31.57",
      "endTime": "2021-12-10T08:40:43.87",
      "type": "Data"
    }
  ]
}

Failed refresh example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/fdb91b8f-0a9b-44c1-b6c0-0cb185c6ebfb/datasets/f7fc6510-e151-42a3-850b-d0805a391db0/refreshes/351f7113-59bb-4e5e-8c1e-e15ae7414121

Sample Response

Status code:: 200

{
  "startTime": "2021-12-10T08:39:28.517",
  "endTime": "2021-12-10T08:39:30.04",
  "type": "Full",
  "commitMode": "PartialBatch",
  "status": "Failed",
  "extendedStatus": "Failed",
  "currentRefreshType": "Full",
  "numberOfAttempts": 0,
  "messages": [
    {
      "message": "RefreshApiRequest for table refresh using refresh policy must have the property 'CommitMode' = 'Transactional' instead of 'PartialBatch'.",
      "type": "Error"
    }
  ],
  "refreshAttempts": [
    {
      "attemptId": 1,
      "startTime": "2021-12-10T08:39:28.517",
      "endTime": "2021-12-10T08:39:30.04",
      "serviceExceptionJson": "{\"errorCode\":\"ModelRefresh_ShortMessage_ProcessingError\",\"errorDescription\":\"0xC112001C: Expression.Error: Forced Error. . The exception was raised by the IDbCommand interface.\\n0xC112001C: The command has been canceled.. The exception was raised by the IDbCommand interface.\\n0xC11C0006: The current operation was cancelled because another operation in the transaction failed.\\n0xC112001C: The command has been canceled.. The exception was raised by the IDbCommand interface.\\n0xC112001C: The command has been canceled.. The exception was raised by the IDbCommand interface.\\n0xC112001C: The command has been canceled.. The exception was raised by the IDbCommand interface.\"}",
      "type": "Data"
    }
  ]
}

In progress refresh example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/fdb91b8f-0a9b-44c1-b6c0-0cb185c6ebfb/datasets/f7fc6510-e151-42a3-850b-d0805a391db0/refreshes/630110f5-8f93-49c2-afee-bfc87072460c

Sample Response

Status code:: 202

{
  "startTime": "2021-12-14T03:46:04.833",
  "type": "Full",
  "commitMode": "Transactional",
  "status": "Unknown",
  "extendedStatus": "NotStarted",
  "currentRefreshType": "Full",
  "numberOfAttempts": 0
}

Définitions

Nom	Description
DatasetRefreshDetail	Une entrée de détails d’actualisation Power BI
DatasetRefreshDetailCommitMode	Détermine si les objets seront commités par lots ou uniquement une fois terminés
DatasetRefreshDetailExtendedStatus	Status détaillée de l’opération de jeu de données
DatasetRefreshDetailStatus	Status général de l’opération de jeu de données
DatasetRefreshDetailType	Type de traitement à effectuer
DatasetRefreshObjects	Cible d’actualisation du jeu de données Power BI
EngineMessage	Message d’erreur ou d’avertissement du moteur pour une actualisation améliorée
RefreshAttempt	Power BI effectue automatiquement plusieurs tentatives d’actualisation d’un jeu de données en cas d’échec de l’actualisation. Cet objet contient des informations sur chaque tentative d’actualisation.
RefreshAttemptType	Type de tentative d’actualisation.
RefreshEngineErrorType	Type de l’erreur

DatasetRefreshDetail

Une entrée de détails d’actualisation Power BI

Nom	Type	Description
commitMode	DatasetRefreshDetailCommitMode	Détermine si les objets seront commités par lots ou uniquement une fois terminés
currentRefreshType	DatasetRefreshDetailType	Type de traitement pour l’itération actuelle. Cela est utile lorsque `commitMode` est défini sur `PartialBatch`
endTime	string	Date et heure de fin de l’actualisation (peut être vide si une actualisation est en cours)
extendedStatus	DatasetRefreshDetailExtendedStatus	Status détaillée de l’opération de jeu de données
messages	EngineMessage[]	Tableau de messages d’erreur ou d’avertissement du moteur pour la demande d’actualisation
numberOfAttempts	integer	Nombre de tentatives pour la demande d’actualisation
objects	DatasetRefreshObjects[]	Tableau d’objets inclus dans la demande d’actualisation
refreshAttempts	RefreshAttempt[]	Liste des tentatives d’actualisation.
startTime	string	Date et heure de début de l’actualisation
status	DatasetRefreshDetailStatus	Status général de l’opération de jeu de données
type	DatasetRefreshDetailType	Type de traitement à effectuer

DatasetRefreshDetailCommitMode

Détermine si les objets seront commités par lots ou uniquement une fois terminés

Nom	Type	Description
PartialBatch	string	Valider l’opération d’actualisation par lots
Transactional	string	Valider l’ensemble de l’opération d’actualisation en tant que transaction

DatasetRefreshDetailExtendedStatus

Status détaillée de l’opération de jeu de données

Nom	Type	Description
Cancelled	string	L’opération d’actualisation a été annulée par le client
Completed	string	L’opération d’actualisation s’est terminée avec succès
Disabled	string	L’opération d’actualisation est désactivée par une actualisation sélective
Failed	string	L’opération d’actualisation échoue
InProgress	string	L’opération d’actualisation est en cours
NotStarted	string	L’opération d’actualisation n’est pas démarrée
TimedOut	string	L’opération d’actualisation a expiré
Unknown	string	L’état d’achèvement est inconnu

DatasetRefreshDetailStatus

Status général de l’opération de jeu de données

Nom	Type	Description
Completed	string	L’opération d’actualisation s’est terminée avec succès
Disabled	string	L’opération d’actualisation est désactivée par une actualisation sélective
Failed	string	L’opération d’actualisation échoue
Unknown	string	L’état d’achèvement est inconnu ou une actualisation est en cours

DatasetRefreshDetailType

Type de traitement à effectuer

Nom	Type	Description
Automatic	string	Si l’objet doit être actualisé et recalculé, actualiser et recalculer l’objet et tous ses éléments dépendants. S’applique si la partition est dans un état autre que Prêt.
Calculate	string	Recalculer cet objet et tous ses éléments dépendants, mais seulement si nécessaire. Cette valeur ne force pas le recalcul, sauf pour les formules volatiles.
ClearValues	string	Effacer les valeurs de cet objet et de toutes ses dépendances
DataOnly	string	Actualiser les données de cet objet et effacer toutes les dépendances
Defragment	string	Défragmenter les données dans la table spécifiée. Comme les données sont ajoutées ou supprimées d’une table, les dictionnaires de chaque colonne peuvent devenir pollués par des valeurs qui n’existent plus dans les valeurs actuelles des colonnes. L’option de défragmentation nettoie les valeurs dans les dictionnaires qui ne sont plus utilisées.
Full	string	Pour toutes les partitions dans la partition, la table ou la base de données spécifiée, actualiser les données et recalculer toutes les éléments dépendants. Pour une partition de calcul, recalculer la partition et tous ses éléments dépendants.

DatasetRefreshObjects

Cible d’actualisation du jeu de données Power BI

Nom	Type	Description
partition	string	Partition à actualiser
table	string	Tableau à actualiser

EngineMessage

Message d’erreur ou d’avertissement du moteur pour une actualisation améliorée

Nom	Type	Description
code	string	Code d’erreur au format hexadécimal
message	string	Texte du message d’erreur ou d’avertissement
type	RefreshEngineErrorType	Type de l’erreur

RefreshAttempt

Power BI effectue automatiquement plusieurs tentatives d’actualisation d’un jeu de données en cas d’échec de l’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 void si la tentative d’actualisation est en cours.
serviceExceptionJson	string	Code d’erreur d’échec au format JSON. Void 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

RefreshEngineErrorType

Type de l’erreur

Nom	Type	Description
Error	string	Message d’erreur
Warning	string	Message d'avertissement

Partager via

Datasets - Get Refresh Execution Details In Group

Autorisations

Étendue requise

Paramètres URI

Réponses

Exemples

Completed refresh example

Sample Request

Sample Response

Failed refresh example

Sample Request

Sample Response

In progress refresh example

Sample Request

Sample Response

Définitions

DatasetRefreshDetail

DatasetRefreshDetailCommitMode

DatasetRefreshDetailExtendedStatus

DatasetRefreshDetailStatus

DatasetRefreshDetailType

DatasetRefreshObjects

EngineMessage

RefreshAttempt

RefreshAttemptType

RefreshEngineErrorType

Ressources supplémentaires