Datasets - Trigger Query Scale Out Sync In Group

服務:

Power BI REST APIs

API 版本:

v1.0

從指定的工作區觸發指定數據集只讀複本的查詢向外延展同步處理。

權限

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

必要範圍

Dataset.ReadWrite.All

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

URI 參數

名稱	位於	必要	類型	Description
datasetId	path	True	string	數據集標識碼
groupId	path	True	string (uuid)	工作區標識碼

回應

名稱	類型	Description
200 OK	DatasetQueryScaleOutSyncStatus	還行

範例

Trigger query scale-out sync example

範例要求

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/queryScaleOut/sync

範例回覆

狀態碼:

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

Object

數據集查詢向外延展同步處理狀態

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

QueryScaleOutStatus

列舉型別

查詢向外延展狀態

值	Description
Enabled	已啟用查詢向外延展
ReadOnlyReplicasDisabled	查詢向外延展最大只讀複本設定為 0
StorageModeNotSupported	數據集儲存模式不支持查詢向外延展
TenantSettingDisabled	已停用查詢向外延展租用戶設定

QueryScaleOutSyncTriggerReason

列舉型別

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

值	Description
automatic	已自動觸發同步處理
explicit	已明確觸發同步處理
system	在系統事件之後觸發同步處理