Datasets - Refresh Dataset In Group
从指定的工作区中触发指定数据集的刷新。 仅当设置了除 notifyOption
以外的请求有效负载时,才会触发 增强刷新。
权限
此 API 调用可由服务主体配置文件调用。 有关详细信息,请参阅:Power BI Embedded中的服务主体配置文件。
所需范围
Dataset.ReadWrite.All
局限性
- 对于共享容量,每天最多可以启动 8 个请求,包括使用计划刷新执行的刷新。
- 对于共享容量,只能在请求正文中指定
notifyOption
。 - 共享容量不支持增强刷新。
- 对于增强刷新,不需要
notifyOption
,并且必须从请求正文中排除。 但是,除notifyOption
以外的一个或多个参数是必需的。 - 对于高级容量,每天的最大请求数仅受容量中的可用资源的限制。 如果可用资源过载,则会限制刷新,直到负载降低。 如果限制超过 1 小时,刷新将失败。
POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/{datasetId}/refreshes
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
dataset
|
path | True |
string |
数据集 ID |
group
|
path | True |
string uuid |
工作区 ID |
请求正文
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
notifyOption | True |
邮件通知选项。 此参数不适用于使用服务主体进行增强的刷新或 API 操作。 |
|
applyRefreshPolicy |
boolean |
确定策略是否已应用 |
|
commitMode |
确定对象是批量提交还是仅在完成时提交 |
||
effectiveDate |
string |
如果应用增量刷新策略, |
|
maxParallelism |
integer |
运行并行处理命令的最大线程数 |
|
objects |
要处理的对象数组 |
||
retryCount |
integer |
操作在失败之前将重试的次数。 临时内部错误可能会触发刷新的重试,即使此参数设置为 0 也是如此。 |
|
type |
要执行的处理类型 |
响应
名称 | 类型 | 说明 |
---|---|---|
202 Accepted |
接受 标头
|
示例
Example of refreshing a dataset |
Example of refreshing one partition |
Example of refreshing a dataset
示例请求
POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes
{
"notifyOption": "MailOnFailure",
"retryCount": 3
}
示例响应
x-ms-request-id: 87f31ef7-1e3a-4006-9b0b-191693e79e9e
Location: https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes/87f31ef7-1e3a-4006-9b0b-191693e79e9e
Example of refreshing one partition
示例请求
POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes
{
"type": "full",
"commitMode": "transactional",
"objects": [
{
"table": "Customer",
"partition": "Robert"
}
],
"applyRefreshPolicy": "false"
}
示例响应
定义
名称 | 说明 |
---|---|
Dataset |
确定对象是批量提交还是仅在完成时提交 |
Dataset |
Power BI 数据集刷新目标 |
Dataset |
Power BI 数据集刷新请求 |
Dataset |
要执行的处理类型 |
Notify |
邮件通知选项 |
DatasetCommitMode
确定对象是批量提交还是仅在完成时提交
名称 | 类型 | 说明 |
---|---|---|
PartialBatch |
string |
批量提交刷新操作。 使用 |
Transactional |
string |
以事务的形式提交整个刷新操作 |
DatasetRefreshObjects
Power BI 数据集刷新目标
名称 | 类型 | 说明 |
---|---|---|
partition |
string |
要刷新的分区 |
table |
string |
要刷新的表 |
DatasetRefreshRequest
Power BI 数据集刷新请求
名称 | 类型 | 说明 |
---|---|---|
applyRefreshPolicy |
boolean |
确定策略是否已应用 |
commitMode |
确定对象是批量提交还是仅在完成时提交 |
|
effectiveDate |
string |
如果应用增量刷新策略, |
maxParallelism |
integer |
运行并行处理命令的最大线程数 |
notifyOption |
邮件通知选项。 此参数不适用于使用服务主体进行增强的刷新或 API 操作。 |
|
objects |
要处理的对象数组 |
|
retryCount |
integer |
操作在失败之前将重试的次数。 临时内部错误可能会触发刷新的重试,即使此参数设置为 0 也是如此。 |
type |
要执行的处理类型 |
DatasetRefreshType
要执行的处理类型
名称 | 类型 | 说明 |
---|---|---|
Automatic |
string |
如果需要刷新并重新计算对象,请刷新并重新计算对象及其所有依赖项。 如果分区处于“就绪”以外的状态,则适用。 |
Calculate |
string |
重新计算此对象及其所有依赖项,但前提是需要。 此值不强制重新计算,但可变公式除外。 |
ClearValues |
string |
清除此对象及其所有依赖项中的值 |
DataOnly |
string |
刷新此对象中的数据并清除所有依赖项 |
Defragment |
string |
对指定表中的数据进行碎片整理。 在表中添加或删除数据时,每个列的字典可能会因实际列值中不再存在的值而受到污染。 碎片整理选项将清理不再使用的字典中的值。 |
Full |
string |
对于指定分区、表或数据库中的所有分区,请刷新数据并重新计算所有依赖项。 对于计算分区,请重新计算分区及其所有依赖项。 |
NotifyOption
邮件通知选项
名称 | 类型 | 说明 |
---|---|---|
MailOnCompletion |
string |
一条邮件通知,指示刷新完成时将发送成功或失败 |
MailOnFailure |
string |
刷新失败时将发送邮件通知 |
NoNotification |
string |
不会发送通知 |