Databricks SQL API 参考

重要

此功能目前以公共预览版提供。

Databricks SQL REST API 支持用于管理查询和仪表板、查询历史记录及 SQL 终结点的服务。

本文概述了如何使用 REST API。 本文末尾列出了各个 API 参考的链接。

若要了解如何使用个人访问令牌向 REST API 进行身份验证,请参阅在 Databricks SQL 中使用 Azure Databricks 个人访问令牌进行身份验证

若要了解如何使用 Azure Active Directory 令牌向 REST API 进行身份验证,请参阅使用 Azure Active Directory 令牌进行身份验证。 有关示例,请参阅使用用户的 Azure AD 访问令牌使用服务主体的 AAD 访问令牌

速率限制

Databricks REST API 支持每个工作区最多 30 个请求/秒。 超过速率限制的请求会出现 429 响应状态代码

分析输出

分析 JSON 输出的各个部分可能很有用。 在这种情况下,建议使用实用工具 jq。 有关详细信息,请参阅 jq 手册。 可以通过运行 brew install jq 来使用 Homebrew 在 MacOS 上安装 jq

某些 STRING 字段(其中包含供 UI 使用的错误和描述性消息)未结构化,在编程工作流中请不要依赖这些字段的格式。

使用查询字符串来调用 GET

尽管大多数 API 调用都要求必须指定 JSON 正文,但对于 GET 调用,可指定要检索的对象。 例如,若要获取 SQL 终结点的详细信息,请运行:

curl ... https://<databricks-instance>/api/2.0/sql/endpoints/<endpoint-id>

向 Databricks SQL API 进行身份验证

Databricks SQL API