SQL 分析 API 參考SQL Analytics API reference


這項功能處於公開預覽狀態This feature is in Public Preview. 請連絡 Azure Databricks 代表以要求存取權。Contact your Azure Databricks representative to request access.

Databricks SQL 分析 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 存取權杖使用服務主體的 Azure AD 存取權杖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. 在這些情況下,建議您使用 jq 公用程式。In these cases, we recommend that you to use the utility jq. 如需詳細資訊,請參閱 jq 手冊For more information, see the jq Manual. 您可以執行 brew install jq,以在 MacOS 上使用 Homebrew 來安裝 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>