Datasets - Get Refresh Execution Details In Group

リファレンス

サービス:: Power BI REST APIs

API バージョン:: v1.0

指定したワークスペースから、指定したデータセットの拡張更新操作の実行の詳細を返します。

権限

この API 呼び出しは、サービスプリンシパルプロファイルによって呼び出すことができます。詳細については、「Power BI Embeddedでのサービスプリンシパルプロファイルの」を参照してください。

必要なスコープ

Dataset.ReadWrite.All または Dataset.Read.All

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

URI パラメーター

名前	/	必須	型	説明
datasetId	path	True	string (uuid)	データセット ID
groupId	path	True	string (uuid)	ワークスペース ID
refreshId	path	True	string (uuid)	更新 ID

応答

名前	型	説明
200 OK	DatasetRefreshDetail	OK (この応答は、更新操作が完了または失敗したときに返されます)
202 Accepted	DatasetRefreshDetail	受け入れ済み (この応答は、更新操作がまだ進行中の場合に返されます)

例

Completed refresh example

Failed refresh example

In progress refresh example

Completed refresh example

要求のサンプル

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

応答のサンプル

状態コード:: 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

要求のサンプル

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

応答のサンプル

状態コード:: 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

要求のサンプル

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

応答のサンプル

状態コード:: 202

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

定義

名前	説明
DatasetRefreshDetail	Power BI 更新の詳細エントリ
DatasetRefreshDetailCommitMode	オブジェクトがバッチでコミットされるか、完了したときにのみコミットされるかを決定します
DatasetRefreshDetailExtendedStatus	データセット操作の詳細な状態
DatasetRefreshDetailStatus	データセット操作の全般状態
DatasetRefreshDetailType	実行する処理の種類
DatasetRefreshObjects	Power BI データセットの更新ターゲット
EngineMessage	強化された更新のためのエンジンからのエラーまたは警告メッセージ
RefreshAttempt	Power BI では、更新エラーが発生した場合に、データセットの更新が複数回試行されます。このオブジェクトには、各更新の試行に関する情報が含まれています。
RefreshAttemptType	更新の試行の種類。
RefreshEngineErrorType	エラーの種類

DatasetRefreshDetail

Object

Power BI 更新の詳細エントリ

名前	型	説明
commitMode	DatasetRefreshDetailCommitMode	オブジェクトがバッチでコミットされるか、完了したときにのみコミットされるかを決定します
currentRefreshType	DatasetRefreshDetailType	現在のイテレーションの処理の種類。これは、`commitMode` が `PartialBatch` に設定されている場合に便利です
endTime	string (date-time)	更新の終了日時 (更新が進行中の場合は空になる場合があります)
extendedStatus	DatasetRefreshDetailExtendedStatus	データセット操作の詳細な状態
messages	EngineMessage[]	更新要求のエンジンエラーまたは警告メッセージの配列
numberOfAttempts	integer	更新要求の試行回数
objects	DatasetRefreshObjects[]	更新要求に含まれるオブジェクトの配列
refreshAttempts	RefreshAttempt[]	更新の試行の一覧。
startTime	string (date-time)	更新の開始日時
status	DatasetRefreshDetailStatus	データセット操作の全般状態
type	DatasetRefreshDetailType	実行する処理の種類

DatasetRefreshDetailCommitMode

列挙

オブジェクトがバッチでコミットされるか、完了したときにのみコミットされるかを決定します

値	説明
PartialBatch	更新操作をバッチでコミットする
Transactional	更新操作全体をトランザクションとしてコミットする

DatasetRefreshDetailExtendedStatus

列挙

データセット操作の詳細な状態

値	説明
Cancelled	更新操作が顧客によって取り消されました
Completed	更新操作が正常に完了しました
Disabled	選択的更新によって更新操作が無効になる
Failed	更新操作が失敗しました
InProgress	更新操作が進行中です
NotStarted	更新操作が開始されていません
TimedOut	更新操作がタイムアウトしました
Unknown	完了状態が不明です

DatasetRefreshDetailStatus

列挙

データセット操作の全般状態

値	説明
Completed	更新操作が正常に完了しました
Disabled	選択的更新によって更新操作が無効になる
Failed	更新操作が失敗しました
Unknown	完了状態が不明であるか、更新が進行中です

DatasetRefreshDetailType

列挙

実行する処理の種類

値	説明
Automatic	オブジェクトを更新して再計算する必要がある場合は、オブジェクトとそのすべての依存オブジェクトを更新して再計算します。パーティションが準備完了以外の状態の場合に適用されます。
Calculate	必要な場合にのみ、このオブジェクトとそのすべての依存オブジェクトを再計算します。この値は、揮発性の数式を除き、再計算を強制しません。
ClearValues	このオブジェクトとそのすべての依存オブジェクトの値をクリアする
DataOnly	このオブジェクトのデータを更新し、すべての依存オブジェクトをクリアする
Defragment	指定したテーブル内のデータを最適化します。データがテーブルに追加またはテーブルから削除されると、各列のディクショナリが、実際の列の値に存在しなくなった値で汚染される可能性があります。最適化オプションは、使用されなくなったディクショナリ内の値をクリーンアップします。
Full	指定したパーティション、テーブル、またはデータベース内のすべてのパーティションについて、データを更新し、すべての依存を再計算します。計算パーティションの場合は、パーティションとそのすべての依存を再計算します。

DatasetRefreshObjects

Object

Power BI データセットの更新ターゲット

名前	型	説明
partition	string	更新するパーティション
table	string	更新するテーブル

EngineMessage

Object

強化された更新のためのエンジンからのエラーまたは警告メッセージ

名前	型	説明
code	string	16 進形式のエラーコード
message	string	エラーまたは警告メッセージのテキスト
type	RefreshEngineErrorType	エラーの種類

RefreshAttempt

Object

Power BI では、更新エラーが発生した場合に、データセットの更新が複数回試行されます。このオブジェクトには、各更新の試行に関する情報が含まれています。

名前	型	説明
attemptId	integer	更新の試行のインデックス。
endTime	string (date-time)	更新の試行の終了日時。更新の試行が進行中の場合、値は void です。
serviceExceptionJson	string	JSON 形式のエラーエラーコード。エラーがない場合は Void。
startTime	string (date-time)	更新の試行の開始日時。
type	RefreshAttemptType	更新の試行の種類。

RefreshAttemptType

列挙

更新の試行の種類。

値	説明
Data	更新によってデータセットにデータが読み込まれます。
Query	Premium クエリキャッシュとダッシュボードタイルの更新の試行。u

RefreshEngineErrorType

列挙

エラーの種類

値	説明
Error	エラーメッセージ
Warning	警告メッセージ

次の方法で共有

Datasets - Get Refresh Execution Details In Group

権限

必要なスコープ

URI パラメーター

応答

例

Completed refresh example

要求のサンプル

応答のサンプル

Failed refresh example

要求のサンプル

応答のサンプル

In progress refresh example

要求のサンプル

応答のサンプル

定義

DatasetRefreshDetail

DatasetRefreshDetailCommitMode

DatasetRefreshDetailExtendedStatus

DatasetRefreshDetailStatus

DatasetRefreshDetailType

DatasetRefreshObjects

EngineMessage

RefreshAttempt

RefreshAttemptType

RefreshEngineErrorType