列出组织中的 codespace

可以列出组织当前处于活动状态或已停止的所有 codespace。

谁可以使用此功能？

To list all of the current codespaces for your organization, you must be an organization owner.

使用 GitHub Team 和 GitHub Enterprise 计划的组织可以为成员和协作者对 GitHub Codespaces 的使用付费。 然后，这些组织可以访问设置和策略来管理由组织支付的 codespace。 有关详细信息，请参阅“选择谁拥有组织中的 codespace 并为其付费”和“GitHub 的计划”。

概述

作为组织所有者，可以列出组织当前处于活动状态和已停止的所有 codespace。 你可能想要执行此操作来检查用户正在创建多少 codespace，以确保不会产生不必要的成本。 有关定价的信息，请参阅“关于 GitHub Codespaces 的计费”。

列出组织的 codespace 的最简单方法是使用 GitHub CLI。 还可以使用 REST API，该 API 提供有关每个 codespace 的详细信息。

有关如何查看组织或企业当前总的 Codespaces 使用情况并生成详细报告的信息，请参阅“查看 GitHub Codespaces 使用情况”。

使用 GitHub CLI 列出 codespace

若要列出指定组织的所有当前 codespace，请使用以下命令。

Shell
gh codespace list --org ORGANIZATION

此命令返回一个列表，其中包含每个 codespace 的以下信息：

  • 名称和显示名称
  • 创建 codespace 的用户
  • 存储库和分支
  • codespace 的当前状态

若要列出由特定用户创建的组织的所有当前 codespace，请使用以下命令。

Shell
gh codespace list --org ORGANIZATION --user USER

注意：在上述命令中，将 ORGANIZATION 替换为要查询的组织的名称。 你必须是组织的所有者。

使用 REST API 列出 codespace

可以将 /orgs/{org}/codespaces API 终结点用作列出组织当前 codespace 的替代方法。 这将返回比 GitHub CLI 更详细的信息；例如，计算机类型详细信息。

有关此终结点的详细信息，请参阅“适用于 Codespaces 组织的 REST API 终结点”。