Datasets - Get Query Scale Out Sync Status In Group

Service:

Power BI REST APIs

API Version:

v1.0

從指定的工作區傳回指定資料集的查詢向外延展同步狀態。

權限

此 API 呼叫可由服務主體設定檔呼叫。 如需詳細資訊，請參閱：Power BI Embedded中的服務主體設定檔。

必要範圍

Dataset.ReadWrite.All 或 Dataset.Read.All

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

URI 參數

名稱	位於	必要	類型	Description
datasetId	path	True	string	資料集識別碼
groupId	path	True	string uuid	工作區識別碼

回應

名稱	類型	Description
200 OK	DatasetQueryScaleOutSyncStatus	確定

範例

Get query scale-out sync status example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/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"
}

定義

名稱	Description
DatasetQueryScaleOutSyncStatus	資料集查詢向外延展同步狀態
QueryScaleOutStatus	查詢向外延展狀態
QueryScaleOutSyncTriggerReason	查詢向外延展同步觸發程式原因

DatasetQueryScaleOutSyncStatus

資料集查詢向外延展同步狀態

名稱	類型	Description
commitTimestamp	string	指出最新認可版本的時間戳記
commitVersion	integer	最新認可版本
minActiveReadTimestamp	string	指出使用中讀取版本下限的時間戳記
minActiveReadVersion	integer	最低使用中讀取版本
scaleOutStatus	QueryScaleOutStatus	查詢向外延展狀態
syncEndTime	string	指出上次同步結束時間的時間戳記
syncStartTime	string	時間戳記，指出上次同步處理何時啟動
targetSyncTimestamp	string	指出目標同步版本的時間戳記
targetSyncVersion	integer	目標同步版本
triggerReason	QueryScaleOutSyncTriggerReason	查詢向外延展同步觸發程式原因

QueryScaleOutStatus

查詢向外延展狀態

名稱	類型	Description
Enabled	string	已啟用查詢向外延展
ReadOnlyReplicasDisabled	string	查詢向外延展最大唯讀複本設定為 0
StorageModeNotSupported	string	資料集儲存模式不支援查詢向外延展
TenantSettingDisabled	string	已停用查詢向外延展租使用者設定

QueryScaleOutSyncTriggerReason

查詢向外延展同步觸發程式原因

名稱	類型	Description
automatic	string	同步已自動觸發
explicit	string	已明確觸發同步處理
system	string	在系統事件之後觸發同步處理