Power BI 报表服务器支持表述性状态转移 (REST) API。 REST API 是支持一组 HTTP 操作(方法)的服务终结点,它们提供针对报表服务器中资源的创建、检索、更新或删除访问权限。
REST API 提供以编程方式访问 Power BI 报表服务器目录中对象的选项。 对象包括文件夹、报表、KPI、数据源、数据集、刷新计划、订阅等等。 例如,使用 REST API 可以导航文件夹层次结构、发现文件夹的内容或下载报表定义。 此外还可创建、更新和删除对象。 有关对象使用的例子包括上载报表、执行刷新计划、删除文件夹等等。
注意
如果希望查看和删除个人数据,请在符合 GDPR 的 Windows 数据主体请求站点中查看 Microsoft 的指南。 如果正在寻找有关 GDPR 的一般信息,请参阅服务信任门户的 GDPR 部分。
REST API 请求/响应的组件
REST API 请求/响应对可分解为五个组件:
请求 URI,其中包括:
{URI-scheme} :// {URI-host} / {resource-path} ? {query-string}
。 虽然请求 URI 包含在请求消息标头中,但此处将单独进行调用,因为大多数语言或框架都要求将其与请求消息分开传递。- URI 方案:指示用于传输请求的协议。 例如,
http
或https
。 - URI 主机:指定承载 REST 服务终结点的服务器域名或 IP 地址,例如
myserver.contoso.com
。 - 资源路径:指定资源或资源集合,其中可能包含服务在做资源抉择时使用的多个段。 例如:
CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Properties
可用于获取 CatalogItem 的指定属性。 - 查询字符串(可选):提供其他简单参数,例如 API 版本或资源选择条件。
- URI 方案:指示用于传输请求的协议。 例如,
HTTP 请求消息标头字段:
- 所需的 HTTP 方法(也称为操作或谓词),它告知该服务你请求的操作类型。 Reporting Services REST API 支持 DELETE、GET、HEAD、PUT、POST 和 PATCH 方法。
- 指定的 URI 和 HTTP 方法所需的其他可选的标头字段。
可选的 HTTP 请求消息正文字段,用于支持 URI 和 HTTP 操作。 例如,POST 操作包含作为复杂参数传递的 MIME 编码对象。 对于 POST 或 PUT 操作,还应在
Content-type
请求标头中指定正文的 MIME 编码类型。 某些服务要求使用特定的 MIME 类型,如application/json
。HTTP 响应消息标头字段:
- HTTP 状态代码,包括从 2xx 成功代码到 4xx 或 5xx 错误代码在内的各种代码。 或者,可能返回服务定义的状态代码,如 API 文档中所指示。
- 可选的其他标头字段,用于支持请求的响应,例如
Content-type
响应标头。
可选的 HTTP 响应消息正文字段:
- 在 HTTP 响应正文中返回 MIME 编码的响应对象,例如来自返回数据的 GET 方法的响应。 通常,这些对象以结构化格式(如 JSON 或 XML)返回,如
Content-type
响应标头所指示。
- 在 HTTP 响应正文中返回 MIME 编码的响应对象,例如来自返回数据的 GET 方法的响应。 通常,这些对象以结构化格式(如 JSON 或 XML)返回,如
API 文档
新式 REST API 需要新式 API 文档。 REST API 在 OpenAPI 规范(又称 Swagger 规范)的基础上构建,可在 Microsoft Learn 上获取相关文档。
测试 API 调用
一个用于测试 HTTP 请求/响应消息的工具是 Fiddler。 Fiddler 是一个免费的 Web 调试代理,可以拦截 REST 请求,以便诊断 HTTP 请求/响应消息。
相关内容
查看 Microsoft Learn 上的可用 API。
可在 GitHub 上找到示例。 该示例包含一个基于 TypeScript、React、webpack 构建的 HTML5 应用以及一个 PowerShell 示例。
更多问题? 尝试咨询 Power BI 社区