SQL Analytics API 参考SQL Analytics API reference


此功能目前以公共预览版提供。This feature is in Public Preview. 请联系 Azure Databricks 代表,以申请访问权限。Contact your Azure Databricks representative to request access.

Databricks SQL Analytics REST API 支持用于管理 SQL 终结点和查询历史记录的服务。The Databricks SQL Analytics REST API supports services to manage your SQL endpoints and query history.

本文概述了如何使用 REST API。This article provides an overview of how to use the REST API. 本文末尾列出了各个 API 参考的链接。Links to each API reference are listed at the end of the article.

若要了解如何使用个人访问令牌向 REST API 进行身份验证,请参阅使用 Azure Databricks 个人访问令牌进行身份验证For information about authenticating to the REST API using personal access tokens, see Authentication using Azure Databricks personal access tokens.

若要了解如何使用 Azure Active Directory 令牌向 REST API 进行身份验证,请参阅使用 Azure Active Directory 令牌进行身份验证For information about authenticating to the REST API using Azure Active Directory tokens, see Authenticate using Azure Active Directory tokens. 有关示例,请参阅使用用户的 Azure AD 访问令牌使用服务主体的 AAD 访问令牌For examples, see Use an Azure AD access token for a user and Use an Azure AD access token for a service principal.

速率限制Rate limits

Databricks REST API 支持每个工作区最多 30 个请求/秒。The Databricks REST API supports a maximum of 30 requests/second per workspace. 超过速率限制的请求会出现 429 响应状态代码Requests that exceed the rate limit will receive a 429 response status code.

分析输出Parse output

分析 JSON 输出的各个部分可能很有用。It can be useful to parse out parts of the JSON output. 在这种情况下,建议使用实用工具 jqIn these cases, we recommend that you to use the utility jq. 有关详细信息,请参阅 jq 手册For more information, see the jq Manual. 可以通过运行 brew install jq 来使用 Homebrew 在 MacOS 上安装 jqYou can install jq on MacOS using Homebrew by running brew install jq.

某些 STRING 字段(其中包含供 UI 使用的错误/描述性消息)未结构化,在编程工作流中请不要依赖这些字段的格式。Some STRING fields (which contain error/descriptive messaging intended to be consumed by the UI) are unstructured, and you should not depend on the format of these fields in programmatic workflows.

使用查询字符串来调用 GETInvoke a GET using a query string

尽管大多数 API 调用都要求必须指定 JSON 正文,但对于 GET 调用,可以指定查询字符串。While most API calls require that you specify a JSON body, for GET calls you can specify a query string.

若要获取 SQL 终结点的详细信息,请运行:To get the details for a SQL endpoint, run:

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