Datasets - Get Refresh Execution Details

Referência

Service:: Power BI REST APIs

API Version:: v1.0

Retorna detalhes de execução de uma operação de atualização aprimorada para o conjunto de dados especificado de Meu workspace.

Escopo necessário

Dataset.ReadWrite.All ou Dataset.Read.All

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
datasetId	path	True	string uuid	A ID do conjunto de dados
refreshId	path	True	string uuid	A ID de atualização

Respostas

Nome	Tipo	Description
200 OK	DatasetRefreshDetail	OK (essa resposta é retornada quando a operação de atualização é concluída ou falha)
202 Accepted	DatasetRefreshDetail	Aceito (essa resposta é retornada quando a operação de atualização ainda está em andamento)

Exemplos

Completed refresh example

Failed refresh example

In progress refresh example

Completed refresh example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/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/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/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
}

Definições

Nome	Description
DatasetRefreshDetail	Uma entrada de detalhes de atualização do Power BI
DatasetRefreshDetailCommitMode	Determina se os objetos serão confirmados em lotes ou somente quando concluídos
DatasetRefreshDetailExtendedStatus	Operação de conjunto de dados detalhada status
DatasetRefreshDetailStatus	Status geral da operação do conjunto de dados
DatasetRefreshDetailType	O tipo de processamento a ser executado
DatasetRefreshObjects	Destino de atualização do conjunto de dados do Power BI
EngineMessage	A mensagem de erro ou aviso do mecanismo para atualização aprimorada
RefreshAttempt	O Power BI faz automaticamente várias tentativas de atualizar um conjunto de dados se ele apresentar uma falha de atualização. Esse objeto contém informações sobre cada tentativa de atualização.
RefreshAttemptType	O tipo de tentativa de atualização.
RefreshEngineErrorType	O tipo do erro

DatasetRefreshDetail

Uma entrada de detalhes de atualização do Power BI

Nome	Tipo	Description
commitMode	DatasetRefreshDetailCommitMode	Determina se os objetos serão confirmados em lotes ou somente quando concluídos
currentRefreshType	DatasetRefreshDetailType	O tipo de processamento para a iteração atual. Isso é útil quando é definido como `commitModePartialBatch`
endTime	string	A data e a hora de término da atualização (pode estar vazia se uma atualização estiver em andamento)
extendedStatus	DatasetRefreshDetailExtendedStatus	Operação de conjunto de dados detalhada status
messages	EngineMessage[]	Uma matriz de mensagens de erro ou aviso do mecanismo para a solicitação de atualização
numberOfAttempts	integer	O número de tentativas para a solicitação de atualização
objects	DatasetRefreshObjects[]	Uma matriz de objetos incluídos na solicitação de atualização
refreshAttempts	RefreshAttempt[]	A lista de tentativas de atualização.
startTime	string	A data e a hora de início da atualização
status	DatasetRefreshDetailStatus	Status geral da operação do conjunto de dados
type	DatasetRefreshDetailType	O tipo de processamento a ser executado

DatasetRefreshDetailCommitMode

Determina se os objetos serão confirmados em lotes ou somente quando concluídos

Nome	Tipo	Description
PartialBatch	string	Confirmar a operação de atualização em lotes
Transactional	string	Confirmar toda a operação de atualização como uma transação

DatasetRefreshDetailExtendedStatus

Operação de conjunto de dados detalhada status

Nome	Tipo	Description
Cancelled	string	A operação de atualização foi cancelada pelo cliente
Completed	string	A operação de atualização foi concluída com êxito
Disabled	string	A operação de atualização é desabilitada por uma atualização seletiva
Failed	string	A operação de atualização não foi bem-sucedida
InProgress	string	A operação de atualização está em andamento
NotStarted	string	A operação de atualização não foi iniciada
TimedOut	string	A operação de atualização atingiu o tempo limite
Unknown	string	O estado de conclusão é desconhecido

DatasetRefreshDetailStatus

Status geral da operação do conjunto de dados

Nome	Tipo	Description
Completed	string	A operação de atualização foi concluída com êxito
Disabled	string	A operação de atualização é desabilitada por uma atualização seletiva
Failed	string	A operação de atualização não foi bem-sucedida
Unknown	string	O estado de conclusão é desconhecido ou uma atualização está em andamento

DatasetRefreshDetailType

O tipo de processamento a ser executado

Nome	Tipo	Description
Automatic	string	Se o objeto precisar ser atualizado e recalculado, atualize e recalcule o objeto e todos os seus dependentes. Será aplicado se a partição estiver em um estado diferente de Ready.
Calculate	string	Recalcule este objeto e todos os seus dependentes, mas somente se necessário. Esse valor não força o recálculo, exceto fórmulas voláteis.
ClearValues	string	Limpar valores neste objeto e todos os seus dependentes
DataOnly	string	Atualizar dados neste objeto e limpar todos os dependentes
Defragment	string	Desfragmente os dados na tabela especificada. Como os dados são adicionados ou removidos de uma tabela, os dicionários de cada coluna podem ficar poluídos com valores que não existem mais nos valores de coluna reais. A opção de desfragmentar limpará os valores nos dicionários que não são mais usados.
Full	string	Para todas as partições na partição, tabela ou banco de dados especificado, atualize os dados e recalcule todos os dependentes. Para uma partição de cálculo, recalcule a partição e todos os seus dependentes.

DatasetRefreshObjects

Destino de atualização do conjunto de dados do Power BI

Nome	Tipo	Description
partition	string	Partição a ser atualizada
table	string	Tabela a ser atualizada

EngineMessage

A mensagem de erro ou aviso do mecanismo para atualização aprimorada

Nome	Tipo	Description
code	string	O código de erro no formato hex
message	string	O texto do erro ou da mensagem de aviso
type	RefreshEngineErrorType	O tipo do erro

RefreshAttempt

O Power BI faz automaticamente várias tentativas de atualizar um conjunto de dados se ele apresentar uma falha de atualização. Esse objeto contém informações sobre cada tentativa de atualização.

Nome	Tipo	Description
attemptId	integer	O índice da tentativa de atualização.
endTime	string	A data e a hora de término da tentativa de atualização. O valor será nulo se a tentativa de atualização estiver em andamento.
serviceExceptionJson	string	Código de erro de falha no formato JSON. Nulo se não houver erro.
startTime	string	A data e a hora de início da tentativa de atualização.
type	RefreshAttemptType	O tipo de tentativa de atualização.

RefreshAttemptType

O tipo de tentativa de atualização.

Nome	Tipo	Description
Data	string	A tentativa de atualização de carregar dados no conjunto de dados.
Query	string	A tentativa de atualizar caches de consulta premium e dashboard blocos.u

RefreshEngineErrorType

O tipo do erro

Nome	Tipo	Description
Error	string	Mensagem de erro
Warning	string	Mensagem de aviso

Share via

Datasets - Get Refresh Execution Details

Escopo necessário

Parâmetros de URI

Respostas

Exemplos

Completed refresh example

Sample Request

Sample Response

Failed refresh example

Sample Request

Sample Response

In progress refresh example

Sample Request

Sample Response

Definições

DatasetRefreshDetail

DatasetRefreshDetailCommitMode

DatasetRefreshDetailExtendedStatus

DatasetRefreshDetailStatus

DatasetRefreshDetailType

DatasetRefreshObjects

EngineMessage

RefreshAttempt

RefreshAttemptType

RefreshEngineErrorType

Recursos adicionais