Datasets - Get Query Scale Out Sync Status

Service:

Power BI REST APIs

API Version:

v1.0

[マイ ワークスペース] から、指定したデータセットのクエリ スケールアウト同期状態を返します。

必要なスコープ

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

GET https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}/queryScaleOut/syncStatus

URI パラメーター

名前	/	必須	型	説明
datasetId	path	True	string	データセット ID

応答

名前	型	説明
200 OK	DatasetQueryScaleOutSyncStatus	OK

例

Get query scale-out sync status example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/queryScaleOut/syncStatus

Sample Response

Status code:

200

{
  "commitVersion": 133186221251720662,
  "commitTimestamp": "2023-01-19T17:15:25.1720662Z",
  "targetSyncVersion": 133184583205771509,
  "targetSyncTimestamp": "2023-01-17T19:45:20.5771509Z",
  "triggerReason": "explicit",
  "syncStartTime": "2023-01-17T20:37:49.9625479Z",
  "syncEndTime": "2023-01-17T20:37:50.6029293Z",
  "minActiveReadVersion": 133184583205771509,
  "minActiveReadTimestamp": "2023-01-17T19:45:20.5771509Z",
  "scaleOutStatus": "Enabled"
}

定義

名前	説明
DatasetQueryScaleOutSyncStatus	データセット クエリのスケールアウト同期の状態
QueryScaleOutStatus	クエリ スケールアウトの状態
QueryScaleOutSyncTriggerReason	クエリ スケールアウト同期トリガーの理由

DatasetQueryScaleOutSyncStatus

データセット クエリのスケールアウト同期の状態

名前	型	説明
commitTimestamp	string	最新のコミット バージョンを示すタイムスタンプ
commitVersion	integer	最新のコミット バージョン
minActiveReadTimestamp	string	アクティブな最小読み取りバージョンを示すタイムスタンプ
minActiveReadVersion	integer	アクティブな最小読み取りバージョン
scaleOutStatus	QueryScaleOutStatus	クエリ スケールアウトの状態
syncEndTime	string	最終同期が終了した日時を示すタイムスタンプ
syncStartTime	string	前回の同期が開始された日時を示すタイムスタンプ
targetSyncTimestamp	string	ターゲット同期バージョンを示すタイムスタンプ
targetSyncVersion	integer	ターゲット同期のバージョン
triggerReason	QueryScaleOutSyncTriggerReason	クエリ スケールアウト同期トリガーの理由

QueryScaleOutStatus

クエリ スケールアウトの状態

名前	型	説明
Enabled	string	クエリ のスケールアウトが有効になっている
ReadOnlyReplicasDisabled	string	クエリ スケールアウトの最大読み取り専用レプリカが 0 に設定されている
StorageModeNotSupported	string	クエリ スケールアウトは、データセットのストレージ モードではサポートされていません
TenantSettingDisabled	string	クエリ スケールアウト テナント設定が無効になっている

QueryScaleOutSyncTriggerReason

クエリ スケールアウト同期トリガーの理由

名前	型	説明
automatic	string	同期が自動的にトリガーされました
explicit	string	同期が明示的にトリガーされました
system	string	システム イベントの後に同期がトリガーされました