API 3.x 将于 2023 年 8 月停用
我们之前曾通知您，此项变更将于 2023 年 7 月版本中实施。根据客户的反馈，我们将此截止日期推迟到了 2023 年 8 月，以便您更顺利地完成此次转换。关闭此对话框可了解更多详情。
在 Looker 22.4 中发布 API 4.0 正式版后，我们宣布弃用 3.1 API，以及已经弃用的 3.0 API。
自 2022 年 6 月发布弃用公告以来，3.1 API 和 3.0 API（统称为 3.x）均处于弃用状态。从 2023 年 8 月发布的 Looker 23.14 版开始，3.x API 版本将被停用。
此升级将于 8 月 14 日至 8 月 24 日期间在维护时段内向 Looker 托管的实例推出。因此，所有 Looker 托管的实例都必须在 2023 年 8 月 14 日之前升级其应用，以使用 4.0 API 端点，而不是 3.x API 端点。此项变更生效后，任何依赖于 3.x 端点的功能都将停止运行。
如果您的实例是自托管的，则必须先升级应用，然后才能将 Looker 实例升级到 23.14 或更高版本。
4.0 API 完全涵盖了已弃用 API 提供的功能，我们预计大多数客户可以轻松地从 3.x 升级到 4.0。
无法成功迁移到 API 4.0 的客户应联系 Looker 支持团队。
时间轴
- 2022 年之前：API 3.0 处于已弃用状态，3.1 处于稳定状态，4.0 处于 Beta 版状态
- 2022 年 3 月：API 4.0 进入稳定状态，并在 Looker 22.4 中正式发布
- 2022 年 6 月：宣布弃用 API 3.1
- 2023 年 8 月：Looker 中的 API 3.x 将停用
哪些人应该阅读本文？
如果您通过 Looker 支持的 SDK、社区支持的 SDK 或 API 本身使用 Looker API，则本文档适合您。请继续阅读，了解可能影响您应用的破坏性更改，并了解
我需要做什么？
您需要对代码进行以下更改。本页面后面部分将对此进行详细介绍。
- 更改代码，使其指向新 API。
- 识别已移除端点的使用情况，并将其替换为 API 4.0 中的等效端点。
- 将之前表示为数字的 ID 值更新为表示为字符串。
API 4.0 迁移详情
更改代码以指向新 API
直接通过命令行或 Postman 等程序进行 API 调用时，您需要调整用于发出请求的网址。
### API 3.1 ###
GET https://myinstance.looker.com/api/3.1/users/5877
### API 4.0 ###
GET https://myinstance.looker.com/api/4.0/users/5877
如果您使用的是我们的某个 SDK，则需要确保初始化的是正确版本的 SDK。以下是一个基本示例，展示了使用两个版本的 SDK 时 Python 脚本的开头部分可能是什么样子：
### API 3.1 ###
import looker_sdk
sdk = looker_sdk.init31()
### API 4.0 ###
import looker_sdk
sdk = looker_sdk.init40()
对 4.0 API 进行更改后，您需要测试代码并留意以下变化。
API 3.x 端点替换
为了使 Looker API 和 Looker 界面之间的术语保持一致，API 4.0 将一些已弃用的 API 3.x 端点替换为等效或改进的端点，如下所示：
“聊天室”端点已重命名。请改用同义的“文件夹”端点。
- 查看文件夹功能文档。
- 请参阅文件夹 API 端点列表。
Python SDK 示例
##################### ##### API 3 ######### ##################### # Create Folder in Shared Folders response = sdk.create_space( body=mdls.CreateSpace( name="My New Folder", parent_id="1" ) ) # Get Folder info by ID response = sdk.space(space_id="555") # Change name of existing Folder response = sdk.update_space( space_id="555", body=mdls.UpdateSpace( name="My Updated Folder" ) ) ##################### ##### API 4 ######### ##################### # Create Folder in Shared Folders response = sdk.create_folder( body=mdls.CreateFolder( name="My New Folder", parent_id="1" ) ) # Get Folder info by ID response = sdk.folder(folder_id="555") # Change name of existing Folder response = sdk.update_folder( space_id="555", body=mdls.UpdateFolder( name="My Updated Folder" ) )
cURL 示例
##################### ##### API 3 ######### ##################### # Get Folder info by IDcurl -H "Authorization: token Tg7gjGZD7B8c3k7g6XtmbcyYrQgMrXpjkR25dQ2G" https://myinstance.looker.com/api/3.1/spaces/555# Change name of existing Foldercurl -X PATCH https://myinstance.looker.com/api/3.1/spaces/555 -H "Authorization: token Tg7gjGZD7B8c3k7g6XtmbcyYrQgMrXpjkR25dQ2G" -H "Content-Type: application/json" -d "{\"name\": \"My Updated Space\"}"##################### ##### API 4 ######### ##################### # Get Folder info by IDcurl -H "Authorization: token Tg7gjGZD7B8c3k7g6XtmbcyYrQgMrXpjkR25dQ2G" https://myinstance.looker.com/api/4.0/folders/555# Change name of existing Foldercurl -X PATCH https://myinstance.looker.com/api/4.0/folders/555 -H "Authorization: token Tg7gjGZD7B8c3k7g6XtmbcyYrQgMrXpjkR25dQ2G" -H "Content-Type: application/json" -d "{\"name\": \"My Updated Space\"}"
“首页”端点已被移除。请改用功能更丰富的“board”端点。
- 查看主板功能文档。
- 请参阅主板 API 端点列表。
Python SDK 示例
##################### ##### API 3 ######### ##################### # Get Board info by ID response = sdk.homepage(homepage_id=1348) # Update displayed title of Board item response = sdk.update_homepage_item( homepage_item_id=86, body=mdls.WriteHomepageItem( custom_title="Volume 3" ) ) ##################### ##### API 4 ######### ##################### # Get Board info by ID response = sdk.board(board_id=1348) # Update displayed title of Board item response = sdk.update_board_item( board_item_id=86, body=mdls.WriteBoardItem( custom_title="Volume 3" ) )
cURL 示例
##################### ##### API 3 ######### ##################### # Get Board info by IDcurl -H "Authorization: token Tg7gjGZD7B8c3k7g6XtmbcyYrQgMrXpjkR25dQ2G" https://myinstance.looker.com/api/3.1/homepages/1348# Update displayed title of Board itemcurl -X PATCH https://myinstance.looker.com/api/3.1/homepage_items/86 -H "Authorization: token Tg7gjGZD7B8c3k7g6XtmbcyYrQgMrXpjkR25dQ2G" -H "Content-Type: application/json" -d "{\"custom_title\": \"Volume 3\"}"##################### ##### API 4 ######### ##################### # Get Board info by IDcurl -H "Authorization: token Tg7gjGZD7B8c3k7g6XtmbcyYrQgMrXpjkR25dQ2G" https://myinstance.looker.com/api/4.0/boards/1348# Update displayed title of Board itemcurl -X PATCH https://myinstance.looker.com/api/4.0/boards/86 -H "Authorization: token Tg7gjGZD7B8c3k7g6XtmbcyYrQgMrXpjkR25dQ2G" -H "Content-Type: application/json" -d "{\"custom_title\": \"Volume 3\"}"
API 4.0 破坏性 ID 字段类型
API 4.0 已将某些 ID 字段的类型从数字更新为字符串。使用我们的 API 参考文档差异工具，确定 3.1 和 4.0 之间有哪些 ID 字段发生了变化。使用最新的（23.0 及以上版本）Looker 支持的语言 SDK，确保您的应用在迁移期间和迁移后类型正确。大多数社区支持的语言 SDK（包括 Kotlin、Swift、R、C# 和 Go）也已支持更新后的类型。
使用自定义库的开发者应在代码中搜索对这些字段的引用，以确保这些字段得到妥善处理。
API 4.0 差异
除了此文档页面上列出的准则之外，Looker API Explorer 还提供了 3.x API 与 4.0 API 之间的所有差异的完整列表。
通过旧版功能切换开关停用/启用 API 3.x
对于使用 Looker 23.6、23.8、23.10 和 23.12 的 Looker 托管客户，管理员目前可以停用对 API 3 端点的所有调用。这样，您就可以在实例上进行测试，确保在 8 月 14 日截止日期之前，没有任何集成服务或应用出现故障。为此，您可以在“旧版功能”管理控制台中开启“拒绝 API 3.x 请求”。
使用 Looker 23.6、23.8、23.10 和 23.12 的自托管客户可以在启动 Looker 之前执行以下 shell 命令，以添加一个环境变量，使“拒绝 API 3.x 请求”切换开关可见（注意：执行该命令后，您仍需在 Looker 界面中的“旧版功能”面板中切换该开关，才能停止 API 3 调用）：
export FF_DENY_API3=true
常见问题解答
我不确定我的实例上是否正在进行 API 3.x 调用。如何找到这些信息？
从 Looker 23.8 开始，“管理”>“查询”面板中的“来源”列现在会正确显示从 Looker API 发起的查询的 API 版本（v3 或 v4）。这不包括管理员或开发者任务（例如创建用户或 LookML 开发/Git 任务）的相关信息。
我们的内部报告服务提供了有关 API 请求的更详细信息，包括用于完成管理员和 LookML 开发任务的请求。如果客户的实例采用推荐的网络配置，则可以联系 Looker 支持团队，请求导出这些数据。
我自行托管实例。我是否需要在 2023 年 8 月 14 日之前升级？
如果您的实例是自托管的，则需要在升级到 2023 年 8 月版本（版本 23.14）或任何后续版本之前进行更改。我们建议您尽快开始执行此操作，以便能够继续使用受支持的版本，从而获得最佳 Looker 体验。
我的实例由 Looker 托管，但属于 ESR 计划。我是否需要在 2023 年 8 月 14 日之前升级？
您需要在实例升级到 2023 年 8 月版本（版本 23.14）或任何后续版本之前进行更改。我们建议您尽快开始执行此操作，以免在实例计划接收该升级时时间紧迫。
我已阅读文档，但仍遇到问题或不确定如何继续。
无法成功迁移到 API 4.0 的客户应联系 Looker 支持团队。