Datasets - Refresh Dataset

触发指定语义模型的刷新。 语义模型可以驻留在 “我的工作区 ”或其他工作区中,前提是调用方具有所需的权限。 仅当设置了除 以外的请求有效负载时,才会触发 notifyOption。

所需范围

Dataset.ReadWrite.All

局限性

  • 对于共享容量,每天最多可以启动 8 个请求,包括使用计划刷新执行的刷新。
  • 对于共享容量,只能在请求正文中指定 notifyOption。
  • 共享容量不支持增强刷新。
  • 对于增强刷新,不需要 notifyOption,并且必须从请求正文中排除。 但是,除 notifyOption 以外的一个或多个参数是必需的。
  • 对于高级容量,每天的最大请求数仅受容量中的可用资源的限制。 如果可用资源过载,则会限制刷新,直到负载降低。 如果限制超过 1 小时,刷新将失败。

POST https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}/refreshes

URI 参数

名称 在 必需 类型 说明
datasetId
path True

string

数据集 ID

请求正文

名称 必需 类型 说明
notifyOption True

NotifyOption

邮件通知选项。 此参数不适用于使用服务主体进行增强的刷新或 API 操作。

applyRefreshPolicy

boolean

确定策略是否已应用

commitMode

DatasetCommitMode

确定对象是批量提交还是仅在完成时提交

effectiveDate

string (date-time)

如果应用增量刷新策略,effectiveDate 参数将替代当前日期。

maxParallelism

integer

运行并行处理命令的最大线程数

objects

DatasetRefreshObjects[]

要处理的对象数组

retryCount

integer

操作在失败之前将重试的次数。 临时内部错误可能会触发刷新的重试,即使此参数设置为 0 也是如此。

timeout

string

pattern: ^([0-1]?[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$

如果指定了 timeout,则语义模型上的每个数据刷新尝试都将遵循该超时。 请注意,如果指定了 retryCount,单个刷新请求可以包含多次尝试,这可能会导致总刷新持续时间超过指定的超时。 例如,将 timeout 设置为 1 小时,retryCount 为 2 可能会导致总刷新持续时间长达 3 小时。 用户可以调整 timeout,以缩短刷新持续时间,以加快故障检测速度,或者将刷新时间延长到默认 5 小时以上,以便进行更复杂的数据刷新。 但是,总刷新持续时间(包括重试)不能超过 24 小时。

type

DatasetRefreshType

要执行的处理类型

响应

名称 类型 说明
202 Accepted

接受

标头

  • x-ms-request-id: string
  • Location: string

示例

Example of refreshing a dataset
Example of refreshing one partition

Example of refreshing a dataset

示例请求

POST https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes

示例响应

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

示例请求

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",
  "timeout": "05:00:00"
}

示例响应

定义

名称 说明
DatasetCommitMode

确定对象是批量提交还是仅在完成时提交

DatasetRefreshObjects

Power BI 数据集刷新目标

DatasetRefreshRequest

Power BI 数据集刷新请求

DatasetRefreshType

要执行的处理类型

NotifyOption

邮件通知选项

DatasetCommitMode

确定对象是批量提交还是仅在完成时提交

值 说明
Transactional

以事务的形式提交整个刷新操作

PartialBatch

批量提交刷新操作。 使用 partialBatch 模式时,刷新操作不会在事务中发生。 因此,每个命令将单独提交,如果发生故障,模型最终可能处于仅加载数据子集或表留空的状态。 如果想要保证在发生故障时保留以前的数据,则应使用 commitMode = transactional. 执行操作

DatasetRefreshObjects

Power BI 数据集刷新目标

名称 类型 说明
partition

string

要刷新的分区

table

string

要刷新的表

DatasetRefreshRequest

Power BI 数据集刷新请求

名称 类型 说明
applyRefreshPolicy

boolean

确定策略是否已应用

commitMode

DatasetCommitMode

确定对象是批量提交还是仅在完成时提交

effectiveDate

string (date-time)

如果应用增量刷新策略,effectiveDate 参数将替代当前日期。

maxParallelism

integer

运行并行处理命令的最大线程数

notifyOption

NotifyOption

邮件通知选项。 此参数不适用于使用服务主体进行增强的刷新或 API 操作。

objects

DatasetRefreshObjects[]

要处理的对象数组

retryCount

integer

操作在失败之前将重试的次数。 临时内部错误可能会触发刷新的重试,即使此参数设置为 0 也是如此。

timeout

string

pattern: ^([0-1]?[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$

如果指定了 timeout,则语义模型上的每个数据刷新尝试都将遵循该超时。 请注意,如果指定了 retryCount,单个刷新请求可以包含多次尝试,这可能会导致总刷新持续时间超过指定的超时。 例如,将 timeout 设置为 1 小时,retryCount 为 2 可能会导致总刷新持续时间长达 3 小时。 用户可以调整 timeout,以缩短刷新持续时间,以加快故障检测速度,或者将刷新时间延长到默认 5 小时以上,以便进行更复杂的数据刷新。 但是,总刷新持续时间(包括重试)不能超过 24 小时。

type

DatasetRefreshType

要执行的处理类型

DatasetRefreshType

要执行的处理类型

值 说明
Full

对于指定分区、表或数据库中的所有分区,请刷新数据并重新计算所有依赖项。 对于计算分区,请重新计算分区及其所有依赖项。

ClearValues

清除此对象及其所有依赖项中的值

Calculate

重新计算此对象及其所有依赖项,但前提是需要。 此值不强制重新计算,但可变公式除外。

DataOnly

刷新此对象中的数据并清除所有依赖项

Automatic

如果需要刷新并重新计算对象,请刷新并重新计算对象及其所有依赖项。 如果分区处于“就绪”以外的状态,则适用。

Defragment

对指定表中的数据进行碎片整理。 在表中添加或删除数据时,每个列的字典可能会因实际列值中不再存在的值而受到污染。 碎片整理选项将清理不再使用的字典中的值。

NotifyOption

邮件通知选项

值 说明
NoNotification

不会发送通知

MailOnFailure

刷新失败时将发送邮件通知

MailOnCompletion

一条邮件通知,指示刷新完成时将发送成功或失败