更新到最新的 Databricks SQL API 版本

项目
08/08/2024

本文介绍了 Databricks SQL API 最新版本中包含的查询、警报和数据源 API 的更改。使用本文可帮助将应用程序和集成迁移到新的 API 版本。

旧版 API 将继续受支持六个月。此过渡期让你有时间在逐步淘汰旧版本之前进行迁移。

查询 API 的更改

新的查询 API 包含更加用户友好的体验，具有更具描述性的名称、分页响应以及按创建时间自动排序的列表响应。以下列表描述了查询 API 的更改：

API 路径现在为api/2.0/sql/queries，替换/api/2.0/preview/sql/queries的旧路径。
包含新的查询定义，其中具有更具描述性的字段名称和类型。
更新终结点现在支持使用PATCH而不是POST进行部分更新。
更新终结点现在支持转让查询的所有权。以前，仅允许使用 [转让对象所有权 API](/API/workspace/dbsqlpermissions/transfer ownership)。
列表终结点响应现在使用基于令牌的分页进行分页。
列表终结点不再支持按名称或自定义排序进行筛选。相反，所有可访问的查询都会返回并按创建时间的升序排序。
不再支持还原终结点。可以通过 Azure Databricks UI 继续还原已放入回收站的查询。

有关更新的查询 API 的完整文档，请参阅查询。

警报 API 的更改

新的警报 API 包含更加用户友好的体验，其中具有更具描述性的字段名称和类型、对列表终结点的分页响应，以及对部分更新的支持。以下列表描述了警报 API 的更改：

API 路径现在为api/2.0/sql/alerts，替换/api/2.0/preview/sql/alerts的旧路径。
包含新的警报定义，其中使用了更具描述性的字段名称和类型。
更新终结点现在支持使用PATCH而不是POST进行部分更新。
更新终结点现在支持转让查询的所有权。以前，仅允许使用转让对象所有权 API 执行该操作。
列表终结点响应现在使用基于令牌的分页进行分页。
删除终结点现在将警报移动到回收站，而不是永久删除警报。 30 天后，将自动清理已放入回收站的警报。可以通过 Azure Databricks UI 在删除后的 30 天内还原已放入回收站的警报。

有关更新的警报 API 的完整文档，请参阅警报。

对权限 API 的更改

权限 API 不再支持“获取对象 ACL”或“设置对象 ACL”。使用工作区 API 管理这些操作的权限。

标记为旧版的数据源 API

数据源 API 现在标记为旧版。目前，其功能仅限于获取 SQL 仓库的列表。由于新的查询 API 支持传入和返回 SQL 仓库 ID 而不是数据源 ID，因此不再需要在数据源和 SQL 仓库之间转换单独的 API 调用。