Dokumentacja interfejsu API SQL Databricks

Interfejs API REST usługi Databricks SQL obsługuje usługi do zarządzania zapytaniami i pulpitami nawigacyjnymi, historią zapytań SQL końcowych.

Ten artykuł zawiera omówienie sposobu korzystania z interfejsu API REST. Linki do dokumentacji poszczególnych interfejsów API znajdują się na końcu artykułu.

Aby uzyskać informacje na temat uwierzytelniania w interfejsie API REST przy użyciu osobistych tokenów dostępu, zobacz Authentication using Azure Databricks personal access tokens in Databricks SQL(Uwierzytelnianie przy użyciu osobistych tokenów dostępu w u usługi Databricks SQL).

Informacje o uwierzytelnianiu w interfejsie API REST przy użyciu tokenów usługi Azure Active Directory można znaleźć w artykule Uwierzytelniania przy użyciu tokenów usługi Azure Active Directory. Aby zapoznać się z przykładami, zobacz artykuł Używanie tokenu dostępu usługi Azure AD dla użytkownika i Używanie tokenu dostępu usługi Azure AD dla jednostki usługi.

Limity szybkości

Interfejs API REST usługi Databricks obsługuje maksymalnie 30 żądań/sekundę dla obszaru roboczego. Żądania, które przekraczają limit szybkości, otrzymają kod stanu odpowiedzi 429.

Analiza danych wyjściowych

Pomocne może być przeanalizowanie części danych wyjściowych JSON. W takich przypadkach zalecamy użycie narzędzia jq. Aby uzyskać więcej informacji, zobacz Podręcznik dotyczący jq. Element jq można zainstalować w systemie MacOS za pomocą oprogramowania Homebrew, uruchamiając polecenie brew install jq.

Niektóre pola (zawierające błędy i opisowe komunikaty przeznaczone do obsługi interfejsu użytkownika) są nieustrukturyzowane i nie należy zależeć od formatu tych pól w STRING programowych przepływach pracy.

Wywoływanie żądania GET przy użyciu ciągu zapytania

Większość wywołań interfejsu API wymaga określenia treści JSON, natomiast w przypadku wywołań można określić GET obiekt do pobrania. Aby na przykład uzyskać szczegółowe informacje dotyczące SQL końcowego, uruchom:

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

Uwierzytelnianie w interfejsach API SQL Databricks

Interfejsy API SQL Databricks