您可以监测帐户中的 API 使用量，并在需要时提高 API 使用限制。请务必监测您的 API 使用量，以免受到速率限制。您必须是 Zendesk Support 管理员才能在管理中心查看 API 使用量页面。
关于 API 使用量的默认限制
以下工单处理和帮助中心 API 速率限制适用于您的 Zendesk Suite 和 Support 服务模式。通常，帮助中心 API 的速率限制与 Support 工单系统 API 相同，但对帮助中心 API 的请求不计入 Support API 的速率限制，反之亦然。速率限制还取决于使用的端点、CPU 时间等。请参阅速率限制。
| 服务模式 | 每分钟请求数 |
|---|---|
| Team | 200 |
| Growth | 400 |
| Professional | 400 |
| Enterprise | 700 |
| 多数量 API 附加功能 | 2500 |
Enterprise Plus 服务模式提供多数量 API 附加功能。
根据您的速率限制监测 API 使用量
为帮助您监测帐户的 API 使用量，Zendesk 提供 API 使用量概要。您可以使用此概要查看您当前的使用情况，将使用 API 的活动与速率限制进行比较。
跟踪 API 使用量
- 在管理中心中，单击侧栏中的主页图标
。
您的 API 使用量概要将显示在管理中心主页上。
摘要显示了您的 API 使用量（在最近 7 天内），并与您的 API 速率限制进行了比较。如果超出限制，您将在概要中看到一个警告符号 (!)。
- 要查看更多关于 API 使用量的详情，单击查看详情。
您也可以按照以下说明查看 API 使用详情：
- 在管理中心，单击侧栏中的帐户图标 (
)，然后选择使用量 > API。
系统将显示一个详细的面板，显示 API 使用量。
面板显示 API 使用量概要，并辅以基于时间的使用量图表和表格。有关详情，请参阅下面的关于 API 使用量面板
- 在管理中心，单击侧栏中的帐户图标 (
关于 API 使用量面板
面板涵盖了一段时间内的 API 请求，而表格则按来电人和端点提供了请求总数的细目。内容每天都会刷新，但当前使用情况最多需要 72 小时才会反映在面板中。
7 天概要
7 天概要卡片包括以下信息：
- 429 错误：过去 7 天内 API 速率限制的违规情况（HTTP 429 响应），以该时段内请求总数的百分比表示。
- 限制接近违反：在过去的 7 天内，测得的 API 调用次数在服务模式限制的 90% 到 99% 之间。
- 即将临近限制：在过去 7 天内，API 调用次数达到服务模式限制 80% 到 89% 之间。
限制接近违反和即将临近限制卡片有助于管理员主动防范 429 错误。
API 请求细分
此面板显示在指定时间范围内发生的 API 请求总数、429 错误数、限制接近违反和即将临近限制。
客户端通过所用身份验证凭证识别。下表列出了用于基本身份验证的 API 密钥、OAuth 客户端或用户的名称（或身份）。
面板包括时间、来电人和产品的向下钻取选项。
以下请求将从活动中排除：
- 使用会话身份验证的请求，例如来自 Zendesk 应用的请求或来自帮助中心 JavaScript 代码的客户端请求。
- 无需身份验证的匿名请求，但请求 API（如已激活）除外。
时间范围和粒度
您还可以使用下拉菜单，按时间窗口和粒度显示图表。粒度选项取决于您选择的时间窗口。
| 时间窗口 | 粒度选项 | 注释 |
|---|---|---|
| 1 天 | 每小时 | 24 小时，间隔 1 小时 |
| 7 天 | 每小时、每日 | 7 天，间隔 1 小时或 1 天 |
| 30 天 | 每日、每周、每月 | 30 天，间隔 1 天、1 周或 1 月 |
| 90 天 | 每日、每周、每月 | 90 天，间隔 1 天、1 周或 1 月 |
| 自定义时段 | 因范围而异 | 最大范围为 90 天 |
概要
面板概要显示了指定时间范围内 API 请求总数、429 错误数、限制接近违反和即将临近限制。
图表
条形图根据您指定的时间范围和粒度显示一段时间内的 API 请求数。您可以将图表设置为显示请求数或峰值速率（每分钟请求数）的 API 使用量数据。
- 成功的请求显示蓝色，429 错误显示红色。
- 灰线显示您帐户的 API 速率限制（每分钟请求数）。
- 将鼠标悬停在每个数据点上可以获取更多信息。
水平时间刻度设置为您的本地时间，最右边的标记是最近的。峰值速率显示时间间隔内每分钟的最大请求数。请求数是时间间隔内每分钟的平均请求数。
图表根据活动量进行缩放，这可能会隐藏速率限制线。本例中有足够的活动，表示速率限制的水平线将显示在您服务模式的速率限制处。
表格
图表下方的表格显示了以下信息：
- API 请求数最多的前五名来电人
- 基于通话总数，呼叫次数最频繁的前五个端点
- 根据 429 错误的计数，呼叫次数最频繁的前五个端点
API 使用量通知
当您接近 API 使用限制时，您将看到产品内警告或错误消息。这些消息显示在管理中心主页和 API 使用量页面上。
接近 API 使用量限制时，您将首先看到一条产品内警告消息。请参考以下示例。默认警告阈值是服务模式限制的 80%。
如果接近或超出速率限制，您将收到产品内的关键阈值消息。请参考以下示例。关键阈值是服务模式限制的 90%。
减少 API 的使用量
如果趋近速率限制，请确保您仅按需发起请求。以下是减少请求数量的探索领域：
- 优化代码以消除任何不必要的 API 调用。
- 缓存常用数据。
- 侧载相关数据。
- 使用批量和批量端点。
有关更多信息，请参阅避免速率限制的最佳实践。
如果仍然遇到速率限制问题，您可以通过购买多数量 API 附加功能来提高您的 API 速率限制。请参阅此文章中的提高 API 速率限制。
提高 API 速率限制额
如果您已接近 API 速率限制额，或者您预计 API 活动将急剧增加，可以通过购买附加功能来提高帐户的 API 使用限制。如果您想购买多数量 API 附加功能，请联系您的客户代表或 Zendesk 销售团队以提高 API 速率限制额。此外，拥有符合条件的销售协助和自助服务帐户的客户可直接从其“订阅”页面购买附加功能。请参阅购买多数量 API 附加功能。只有帐户所有者或帐单结算管理员可以购买附加功能。
多数量 API 附加功能将允许的 API 调用数量增加到每分钟 2,500 个请求的更高数量。此附加功能已包含在 Suite Enterprise Plus 中。
多数量 API 附加功能将符合资格的服务模式对工单处理和帮助中心 API 的请求限制增加到每分钟 2500 个。它不会在总体服务模式的限制基础上另增加 2500 个请求。
购买多数量 API 附加功能
如果您有符合条件的销售协助或自助服务帐户，可直接从帐户的“订阅”页面购买多数量 API 附加功能。
购买多数量 API 附加功能
-
在管理中心，单击侧栏中的帐户 ()，然后选择帐单结算 > 订阅。
您当前服务模式的概要信息随即显示。
- 单击管理。
如果您在订阅页面上没有看到管理按钮，则无权进行更改。如果有其他产品可以购买，您会看到“更多产品”选项卡。
- 单击更多产品。
此时会显示可以添加到帐户的产品列表，包括多数量 API 附加功能。仅当您的帐户有资格从购物车购买多数量 API 附加功能时，该附加功能才会列出。
要了解更多关于此附加功能的信息，单击了解更多。
- 单击添加到订阅。
您的订阅概要已更新，以反映购买价格。
- 单击更新订阅以完成购买。
)，然后选择 API > Zendesk API。
22 条评论
登录再写评论。