Datasets - Refresh Dataset
从 “我的工作区”中为指定的数据集触发刷新。 仅当设置了非notifyOption
请求有效负载时,才会触发增强刷新。
必需范围
Dataset.ReadWrite.All
限制
- 对于共享容量,每天最多可以启动 8 个请求,包括使用计划刷新执行的刷新。
- 对于共享容量,只能在
notifyOption
请求正文中指定。 - 共享容量不支持增强刷新。
- 对于增强刷新,
notifyOption
不是必需的,必须从请求正文中排除。 但是,需要一个或多个参数,而不是notifyOption
。 - 对于高级容量,每天的最大请求数仅受容量中的可用资源的限制。 如果可用资源过载,则会限制刷新,直到负载降低。 如果限制超过 1 小时,刷新将失败。
POST https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}/refreshes
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
dataset
|
path | True |
string |
数据集 ID |
请求正文
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
notifyOption | True |
邮件通知选项。 此参数不适用于使用服务主体的增强刷新或 API 操作。 |
|
applyRefreshPolicy |
boolean |
确定是否应用了策略 |
|
commitMode |
确定对象是成批提交还是仅在完成时提交 |
||
effectiveDate |
string |
如果应用了增量刷新策略,则 |
|
maxParallelism |
integer |
运行并行处理命令的最大线程数 |
|
objects |
要处理的对象数组 |
||
retryCount |
integer |
操作失败前将重试的次数 |
|
type |
要执行的处理类型 |
响应
名称 | 类型 | 说明 |
---|---|---|
202 Accepted |
已接受 Headers
|
示例
Example of refreshing a dataset |
Example of refreshing one partition |
Example of refreshing a dataset
Sample Request
POST https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes
Sample Response
x-ms-request-id: 03f22bb5-2e98-4ae8-8113-329bec3987b1
Location: https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes/03f22bb5-2e98-4ae8-8113-329bec3987b1
Example of refreshing one partition
Sample Request
POST https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes
{
"type": "full",
"commitMode": "transactional",
"objects": [
{
"table": "Customer",
"partition": "Robert"
}
],
"applyRefreshPolicy": "false"
}
Sample Response
定义
名称 | 说明 |
---|---|
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 |
操作失败前将重试的次数 |
type |
要执行的处理类型 |
DatasetRefreshType
要执行的处理类型
名称 | 类型 | 说明 |
---|---|---|
Automatic |
string |
如果对象需要刷新并重新计算,则刷新并重新计算对象及其所有依赖项。 如果分区处于“就绪”以外的状态,则应用。 |
Calculate |
string |
仅当需要时,重新计算此对象及其所有依赖项。 除可变公式外,此值不会强制重新计算。 |
ClearValues |
string |
清除此对象及其所有依赖项中的值 |
DataOnly |
string |
刷新此对象中的数据并清除所有依赖项 |
Defragment |
string |
在指定的表中对数据进行碎片整理。 在表中添加或删除数据时,每一列的字典都会受到污染,会出现实际列值中不再存在的值。 碎片整理选项将清除不再使用的字典中的值。 |
Full |
string |
对于指定分区、表或数据库中的所有分区,刷新数据并重新计算所有依赖项。 对于计算分区,重新计算此分区及其所有依赖项。 |
NotifyOption
邮件通知选项
名称 | 类型 | 说明 |
---|---|---|
MailOnCompletion |
string |
指示刷新完成后将发送成功或失败的邮件通知 |
MailOnFailure |
string |
刷新失败时将发送邮件通知 |
NoNotification |
string |
不会发送通知 |