Referenz zur Databricks SQL-API

Wichtig

Dieses Feature befindet sich in der Public Preview.

Von der Databricks SQL-REST-API werden Dienste für die Verwaltung von Abfragen und Dashboards, des Abfrageverlaufs und der SQL-Endpunkte unterstützt.

In diesem Artikel finden Sie eine Übersicht über die Verwendung der REST-API. Links zu den einzelnen API-Referenzen finden Sie am Ende des Artikels.

Informationen zum Authentifizieren bei der REST-API mithilfe persönlicher Zugriffstoken finden Sie unter Authentifizieren mit persönlichen Azure Databricks-Zugriffstoken in Databricks SQL.

Informationen zum Authentifizieren bei der REST-API mithilfe von Azure Active Directory-Token finden Sie unter Authentifizieren mit Azure Active Directory-Token. Beispiele finden Sie unter Verwenden eines Azure AD-Zugriffstokens für einen Benutzer und Verwenden eines Azure AD-Zugriffstokens für einen Dienstprinzipal.

Ratenbegrenzungen

Die Databricks-REST-API unterstützt maximal 30 Anforderungen pro Sekunde und Arbeitsbereich. Bei Anforderungen, die das Limit überschreiten, wird der Statuscode 429 als Antwort empfangen.

Analysieren der Ausgabe

Es kann nützlich sein, Teile der JSON-Ausgabe zu analysieren. In diesen Fällen empfiehlt es sich, das Hilfsprogramm jq zu verwenden. Weitere Informationen finden Sie im Leitfaden zu jq. Sie können jq unter MacOS mit Homebrew installieren, indem Sie brew install jq ausführen.

Einige STRING-Felder (die Fehlermeldungen und beschreibende Meldungen für die Benutzeroberfläche enthalten) sind unstrukturiert. In programmgesteuerten Workflows ist das Format dieser Felder nicht verlässlich.

Aufrufen von GET mithilfe einer Abfragezeichenfolge

Die meisten API-Aufrufe erfordern zwar die Angabe eines JSON-Texts, für GET-Aufrufe können Sie jedoch das abzurufende Objekt angeben. Führen Sie beispielsweise Folgendes aus, um die Details für einen SQL-Endpunkt abzurufen:

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

Authentifizieren bei den APIs von Databricks SQL

Databricks SQL-APIs