Referencia de la API de Databricks SQL
Importante
Esta característica está en versión preliminar pública.
La API REST de Databricks SQL admite servicios para administrar consultas y paneles, el historial de consultas y puntos de conexión SQL.
En este artículo se ofrece información general sobre cómo usar la API REST. Al final del artículo encontrará vínculos a todas las referencias de la API.
Para más información sobre la autenticación en la API REST mediante tokens de acceso personal, consulte Autenticación mediante tokens de acceso personal de Azure Databricks en Databricks SQL.
Para obtener información sobre la autenticación en la API REST mediante tokens de Azure Active Directory, consulte Autenticación mediante tokens de Azure Active Directory. Para obtener ejemplos, consulte Uso de un token de acceso de Azure AD para un usuario y Uso de un token de acceso de Azure AD para una entidad de servicio.
Límites de frecuencia
La API REST de Databricks admite un máximo de 30 solicitudes por segundo por área de trabajo. Las solicitudes que superen el límite de frecuencia recibirán un código de estado de respuesta 429.
Análisis de la salida
Puede ser útil analizar las distintas partes de la salida JSON. En estos casos, se recomienda usar la utilidad jq. Para más información, consulte el manual de jq. jq se puede instalar en MacOS mediante Homebrew. Para ello, se debe ejecutar brew install jq.
Algunos campos de STRING (que contienen mensajes de error y descriptivos destinados a usarse en la interfaz de usuario) no están estructurados y no debería depender del formato de estos campos en sus flujos de trabajo de programación.
Invocación de una instrucción GET mediante una cadena de consulta
Aunque la mayoría de las llamadas API requieren que se especifique un cuerpo JSON, para las llamadas GET se puede especificar el objeto que se va a recuperar. Por ejemplo, para obtener los detalles de un punto de conexión de SQL, ejecute:
curl ... https://<databricks-instance>/api/2.0/sql/endpoints/<endpoint-id>