查看组织中的 API 见解

可以查看整个组织或特定应用和用户的 REST API 活动。

谁可以使用此功能？

Organization owners and users with the "View organization API insights" permission.

Your organization must be on a GitHub Enterprise Cloud plan.

本文内容

Note

此功能目前为 公共预览版 形式，可能会有改动。 欢迎在此 GitHub Community讨论中提供反馈。

关于 API 见解

作为 GitHub Enterprise Cloud 组织所有者，你和你的指定用户可以查看整个组织或特定应用和用户的 REST API 活动。 这可帮助你了解 REST API 活动的来源并针对主要速率限制进行管理，让你了解所涉及的时间范围、应用和 API 终结点。 若要了解有关主要速率限制的详细信息，请参阅 REST API 的速率限制。

Note

目前，此功能仅支持 REST API 终结点的 core 类别和主要速率限制。 搜索的 API 活动、GitHub Actions（使用 GITHUB_TOKEN 机密）以及二级速率限制不受支持。 有关 API 类别的信息，请参阅 速率限制的 REST API 终结点。 若要详细了解主要和次要速率限制，请参阅 REST API 的速率限制。

启用对 API 见解的访问

组织所有者可以创建自定义组织角色，以便用户查看该组织的 API 见解。 若要为用户提供访问权限，请在创建自定义组织角色时选择“查看组织 API 见解”权限****。 然后，将自定义角色分配给组织成员或团队。 有关详细信息，请参阅“关于自定义组织角色”。

Warning

授予组织非所有者访问权限将允许他们查看组织中所有用户和应用的 API 见解，因此应考虑隐私。

了解 API 见解聚合

凭借时间段选择功能，可以查看预定义时间段或自定义时间段内的 API 见解，详细信息如下表所述。 默认情况下，数据以协调世界时 (UTC) 显示。 可以在页面右上角的“时间段”下拉菜单中将显示的数据从 UTC 更改为浏览器所在时区。

周期说明
过去 30 分钟从过去 30 分钟到查看页面时的数据。
过去 1 小时从过去 1 小时到查看页面时的数据。
过去 3 小时从过去 3 小时到查看页面时的数据。
过去 12 小时从过去 12 小时到查看页面时的数据。
最近 24 小时（默认）从过去 24 小时到查看页面时的数据。
最近 7 天从过去 7 天到查看页面时的数据。
过去 31 天从过去 31 天到查看页面时的数据。
自定义你提供的自定义日期和时间范围内的数据。 自定义范围必须从过去 31 天内开始。

查看组织的 API 见解

  1. 在 GitHub 的右上角，选择个人资料照片，然后单击 “你的组织”。

  2. 单击您的组织名称。

  3. 在组织名称下，单击“ 见解”。

    组织的水平导航栏的屏幕截图。 标有图标和“见解”的选项卡以深橙色标出。

  4. 在“见解”导航菜单中，单击“REST API”****。

  5. （可选）若要选择要查看 API 见解的时间段，请从页面右上角的“时间段”下拉菜单中选择一个选项****。 有关详细信息，请参阅了解 API 见解聚合。

  6. （可选）若要在以协调世界时 (UTC) 或浏览器使用的本地时区显示日期和时间之间切换，请从页面右上角的“时间段”下拉菜单中选择“UTC”或“本地”****。

  7. （可选）若要选择在图表上显示 REST API 请求的精细程度，请从页面右上角的“间隔”下拉菜单中选择一个选项****。 较大的间隔显示图表上 API 活动的摘要，而较小的间隔显示所选时间段的更详细的信息。 图表不会自动更新以显示新的活动。

所选时间段和间隔会自动成为页面 URL 的一部分，以便在与他人共享 URL 时，他们会看到同一视图。

查看组织的应用和用户的 API 见解

“参与者”表显示在所选时间段内在当前组织中发出 REST API 请求的 GitHub Apps 和用户。 该表不会自动更新以显示新的活动。

  1. 首先，按照查看组织的 API 见解中的上述步骤查看组织的 API 见解。
  2. 筛选“参与者”表中显示的应用和用户。
    1. 若要按名称进行筛选，请在“参与者”表上方的搜索字段中输入名称的前几个字母。 然后，按 Enter。
    2. 若要按参与者类型（应用或用户）进行筛选，请从“参与者”表右上角的“类型”下拉菜单中选择一个选项****。
    3. 若要按请求类型（全部或主要速率受限）进行筛选，请从“参与者”表右上角的“请求”下拉菜单中选择一个选项****。

查看组织中特定应用或用户的 API 见解

  1. 首先，按照查看组织的 API 见解中的上述步骤查看组织的 API 见解。
  2. （可选）在“参与者”表中选择一个应用以显示其 REST API 活动和所有主要速率限制。 生成的视图将特定于所选应用，并且将显示其所访问的 API 终结点。
  3. （可选）在“参与者”表中选择一位用户以显示其个人 REST API 活动。 生成的视图将特定于所选用户，并且将显示其 personal access tokens 的 API 活动以及 OAuth apps代表其提出的请求。 这两者都有助于用户的个人主要速率限制。 有关用户的主要速率限制以及代表用户执行操作的 OAuth apps 的信息，请参阅 REST API 的速率限制。
    1. （可选）在特定于用户的视图中，单击personal access token或 OAuth app以查看其代表用户进行的 REST API 活动。