Skip to main content

此版本的 GitHub Enterprise Server 已于以下日期停止服务 2024-07-09. 即使针对重大安全问题,也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能,请升级到最新版本的 GitHub Enterprise。 如需升级帮助,请联系 GitHub Enterprise 支持

访问实例的报告

可以下载包含有关 你的 GitHub Enterprise Server 实例 上用户、组织和存储库的信息的报告。

谁可以使用此功能?

Enterprise owners can download reports for a GitHub Enterprise Server instance.

关于 GitHub Enterprise Server

的报告

如果需要获取关于 你的 GitHub Enterprise Server 实例 中用户、组织和存储库的信息,可使用 REST API 提取数据。 有关详细信息,请参阅“REST API 简介”。

REST API 可能无法提供您需要的所有数据,并且需要一定的专业技术知识才能使用。 或者,可以下载包含实例上用户、组织和存储库的概述的报告。

使用 Web UI 下载报表

  1. 在 GitHub Enterprise Server 上的管理帐户中,在任一页面的右上角,单击
  2. 在左侧边栏中,单击“报告”。
  3. 在要下载的报表旁边,单击“下载”。

可以下载报告以下信息的 CSV 文件:

  • 所有用户
  • 所有活跃用户
  • 所有休眠用户
  • 曾被挂起的所有用户
  • 所有组织
  • 所有存储库

以编程方式下载报告

还可以通过标准 HTTP 身份验证和 personal access token 以编程方式访问报告。 必须使用具有 site_admin 范围的 personal access token。 有关详细信息,请参阅“管理个人访问令牌”。

例如,可使用 curl 下载“所有用户”报告:

curl --remote-name \
     --location \
     --user 'USERNAME:TOKEN' \
     http(s)://HOSTNAME/stafftools/reports/all_users.csv

若要以编程方式访问其他报告,请将 all_users 替换为 active_usersdormant_userssuspended_usersall_organizationsall_repositories

注意: 如果没有可用的缓存报告,最初的 curl 请求会返回 HTTP 202 响应。 实例将在后台生成报表。 您可以发送另一个请求来下载报告。 可以使用作用域为 site_admin 的密码或 OAuth 令牌代替密码。

用户报告

密钥说明
created_at用户帐户的创建时间(ISO 8601 时间戳形式)
id用户或组织的帐户 ID
login帐户的登录名称
email帐户的主电子邮件地址
role帐户属于管理员还是普通用户
suspended?帐户是否已挂起
last_logged_ip最近登录帐户的 IP 地址
repos帐户拥有的仓库数量
ssh_keys注册到帐户的 SSH 密钥数量
org_memberships帐户所属的组织数量
dormant?帐户是否休眠
last_active帐户上次活动时间(ISO 8601 时间戳形式)
raw_login原始登录信息(JSON 格式)
2fa_enabled?用户是否已启用双重身份验证

组织报告

密钥说明
id组织 ID
created_at组织创建时间
login组织的登录名称
email组织的主电子邮件地址
owners组织所有者数量
members组织成员数量
teams组织团队数量
repos组织仓库数量
2fa_required?组织是否需要双重身份验证

仓库报告

密钥说明
created_at仓库创建时间
owner_id仓库所有者的 ID
owner_type仓库由用户所有还是由组织所有
owner_name仓库所有者的名称
id仓库 ID
name存储库名称
visibility仓库是公共还是私有
readable_size以人类可读格式表示的仓库大小
raw_size以数字形式表示的仓库大小
collaborators仓库协作者数量
fork?仓库是否为分叉
deleted?仓库是否已删除