Datasets - Get Refresh Schedule In Group

服务:

Power BI REST APIs

API 版本:

v1.0

从指定工作区返回指定数据集的刷新计划。

权限

此 API 调用可由服务主体配置文件调用。 有关详细信息，请参阅：Power BI Embedded 中的服务主体配置文件。

所需范围

Dataset.ReadWrite.All 或 Dataset.Read.All

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/{datasetId}/refreshSchedule

URI 参数

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

响应

名称	类型	说明
200 OK	RefreshSchedule	OK

示例

Refresh schedule example

示例请求

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

示例响应

状态代码:

200

{
  "days": [
    "Sunday",
    "Friday",
    "Saturday"
  ],
  "times": [
    "05:00",
    "11:30",
    "17:30",
    "23:00"
  ],
  "enabled": true,
  "localTimeZoneId": "UTC",
  "notifyOption": "MailOnFailure"
}

定义

名称	说明
days	执行刷新的日期
RefreshSchedule	导入模型的 Power BI 刷新计划
ScheduleNotifyOption	终止计划刷新的通知选项。 服务主体仅支持 NoNotification 值。

days

Enumeration

执行刷新的日期

值	说明
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

RefreshSchedule

Object

导入模型的 Power BI 刷新计划

名称	类型	说明
days	days[]	执行刷新的日期
enabled	boolean	是否启用刷新
localTimeZoneId	string	要使用的时区的 ID。 有关详细信息，请参阅 时区信息。
notifyOption	ScheduleNotifyOption	终止计划刷新的通知选项。 服务主体仅支持 NoNotification 值。
times	string[]	每天执行刷新的时间

ScheduleNotifyOption

Enumeration

终止计划刷新的通知选项。 服务主体仅支持 NoNotification 值。

值	说明
MailOnFailure	刷新失败时将发送邮件通知
NoNotification	不会发送通知