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 参数

名称	在	必需	类型	说明
datasetId	path	True	string	数据集 ID
groupId	path	True	string (uuid)	工作区 ID

响应

名称	类型	说明
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"
}

定义

名称	说明
DatasetQueryScaleOutSyncStatus	数据集查询横向扩展同步状态
QueryScaleOutStatus	查询横向扩展状态
QueryScaleOutSyncTriggerReason	查询横向扩展同步触发器原因

DatasetQueryScaleOutSyncStatus

Object

数据集查询横向扩展同步状态

名称	类型	说明
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

枚举

查询横向扩展状态

值	说明
Enabled	已启用查询横向扩展
ReadOnlyReplicasDisabled	查询横向扩展的最大只读副本设置为 0
StorageModeNotSupported	数据集的存储模式不支持查询横向扩展
TenantSettingDisabled	查询横向扩展租户设置已禁用

QueryScaleOutSyncTriggerReason

枚举

查询横向扩展同步触发器原因

值	说明
automatic	同步已自动触发
explicit	已显式触发同步
system	在系统事件后触发同步