众所周知,Amazon API Gateway 是一个非常实用的服务,它允许开发人员创建、发布、维护、监控和保护任何规模的 API。除了 Amazon API Gateway 可带来的所有好处之外,在使用过程中,开发人员经常会遇到一个常见的问题:默认超时限制是 29 秒。当某些 API 操作需要更多处理时间时,开发人员可能会遇到超时。本文将讨论如何在 Amazon API Gateway 中将超时限制设置超过默认的 29 秒。
请注意 — 此更改最近由 AWS 推出,并且在应用之前需要先申请并获得配额增加。
了解Amazon API Gateway的超时限制:
超时设置控制了Amazon API Gateway在返回客户端错误之前等待集成端点响应的时间。默认情况下,Amazon API Gateway的超时限制设置为29秒。这意味着如果API请求处理时间超过29秒,则Amazon API Gateway将向客户端返回一个超时错误。
延长超时时间的几个关键原因:
在处理大型数据集、进行复杂计算或与慢速外部服务集成时,API 操作可能需要更多的时间来完成。这时,为了防止超时并确保 API 请求能够成功处理,需要延长 Amazon API Gateway 的超时限制以防止超时。
如何将超时限制设置超过29秒的方法:
第一步 — 请求增加Amazon API Gateway的响应超时服务限额, 请按照以下步骤操作:
</TRANSLATION>
- 转到 AWS Management 控制台中的 AWS 服务配额页面。
- 从服务列表中选择“Amazon API Gateway”选项。
- 找到与 Amazon API Gateway 响应超时相关的特定配额,然后点击查看详情。
- 如果当前配额低于您希望设置的超时值,请点击“请求配额增加”按钮。
- 提供所需信息,如希望的超时值、用例及其他支持请求的详情。
- 提交配额增加请求,并等待 AWS 的回复。
- 较小的配额增加请求将自动批准,较大的配额增加请求则需 AWS 审核并告知结果。
- 如果增加配额的请求获批,您就可以在 Amazon API Gateway 中为 API 设置更高的超时值,而不会遇到服务配额限制。
步骤2 - 若要将Amazon API Gateway中的超时限制增加至29秒以上,请按以下步骤:
- 登录到 AWS 管理控制台并导航到 Amazon API Gateway 服务。
- 选择您希望延长超时限制的 Amazon API Gateway API。
- 在 Amazon API Gateway 面板中,转到“资源”部分并点击所需的资源或方法。
- 在所选的资源或方法中,点击“集成请求”或“方法执行”设置。
- 在集成设置中找到“集成超时”选项,并将超时值设置为您所需的限制(例如,60 秒、120 秒等)。
- 保存更改并部署 API,以应用新的超时设置。
在调整Amazon API Gateway的超时设置时,可以参考以下一些常用做法:
- 根据API操作预期的处理时间设置超时限制。
- 定期监控API性能,发现任何与超时设置相关的瓶颈或问题。
- 实施适当的错误处理机制,以便优雅处理超时错误。
- 在不同负载条件下测试API性能,确保其超时设置已优化。
最后:
将超时限制延长超过29秒,开发者可以确保需要更长处理时间的API请求不会因为超时而失败。通过遵循本博客文章中的步骤和最佳实践,开发者可以有效地管理API网关中的超时设置,并优化API性能。