Informations de référence sur l’API Databricks SQL

Important

Cette fonctionnalité est disponible en préversion publique.

L’API REST Databricks SQL prend en charge des services pour gérer les points de terminaison SQL, l’historique des requêtes ainsi que les requêtes et les tableaux de bord.

Cet article présente une vue d’ensemble de l’utilisation de l’API REST. Des liens vers les informations de référence de chaque API sont listés à la fin de cet article.

Pour plus d’informations sur l’authentification auprès de l’API REST à l’aide de jetons d’accès personnels, consultez Authentification à l’aide de jetons d’accès personnels Azure Databricks dans Databricks SQL.

Pour plus d’informations sur l’authentification auprès de l’API REST à l’aide de jetons Azure Active Directory, consultez Authentification à l’aide de jetons Azure Active Directory. Pour obtenir des exemples, consultez Utiliser un jeton d’accès Azure AD pour un utilisateur et Utiliser un jeton d’accès Azure AD pour un principal de service.

Limites du taux de transfert

L’API REST Databricks prend en charge un maximum de 30 demandes par seconde et par espace de travail. Les demandes qui dépassent la limite de débit reçoivent un code d’état de réponse 429.

Analyser la sortie

Il peut être utile d’analyser des parties de la sortie JSON. Dans ces cas, nous vous recommandons d’avoir recours à l’utilitaire jq. Pour plus d’informations, consultez le Manuel jq. Vous pouvez installer jq sur MacOS en utilisant Homebrew avec brew install jq.

Certains champs STRING (qui contiennent une erreur et un message descriptif destinés à être consommés par l’interface utilisateur) ne sont pas structurés, et vous ne devez pas dépendre du format de ces champs dans les workflows programmatiques.

Appeler une méthode GET à l’aide d’une chaîne de requête

Bien que la plupart des appels d’API requièrent que vous spécifiiez un corps JSON, pour les appels GET, vous pouvez spécifier l’objet à récupérer. Par exemple, pour obtenir les détails d’un point de terminaison SQL, exécutez :

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

S’authentifier auprès des API Databricks SQL

API Databricks SQL