REST API 现在已版本化。 有关详细信息，请参阅“关于 API 版本控制”。
Codespaces 机器 REST API 端点
使用 REST API 管理 Codespace 的机器类型可用性。
关于 Codespaces 机器
你可以确定哪些机器类型可用于创建 Codespace，无论是在给定的存储库中还是作为经过身份验证的用户。有关详细信息，请参阅“更改 Codespace 的机器类型”。
你还可以通过更新其 machine 属性在更改现有 Codespace 的机器时使用此信息。机器更新将在下次重新启动 Codespace 时进行。有关详细信息，请参阅“更改 Codespace 的机器类型”。
列出存储库的可用机器类型
根据给定存储库的配置列出可用的机器类型。
OAuth 应用程序令牌和个人访问令牌（经典版）需要 codespace 范围才能使用此端点。
“列出存储库的可用机器类型”的细粒度访问令牌
此端点适用于以下细粒度令牌类型
细粒度令牌必须具有以下权限集
- “Codespaces 元数据”存储库权限（读取）
“列出存储库的可用机器类型”的参数
| 名称、类型、说明 |
|---|
accept 字符串 建议设置为 |
| 名称、类型、说明 |
|---|
owner 字符串 必需存储库的帐户所有者。名称不区分大小写。 |
repo 字符串 必需不带 |
| 名称、类型、说明 |
|---|
location 字符串 要检查可用机器的位置。如果未提供，则按 IP 分配。 |
client_ip 字符串 在代理请求时用于位置自动检测的 IP |
ref 字符串 要检查预构建可用性和 devcontainer 限制的分支或提交。 |
“列出存储库的可用机器类型”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
200 | 确定 |
304 | 未修改 |
401 | 需要身份验证 |
403 | 禁止 |
404 | 未找到资源 |
500 | 内部错误 |
“列出存储库的可用机器类型”的代码示例
请求示例
get/repos/{owner}/{repo}/codespaces/machines
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/codespaces/machines响应
状态：200{ "total_count": 2, "machines": [ { "name": "standardLinux", "display_name": "4 个内核，16 GB RAM，64 GB 存储", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 17179869184, "cpus": 4 }, { "name": "premiumLinux", "display_name": "8 个内核，32 GB RAM，64 GB 存储", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 34359738368, "cpus": 8 } ] }列出代码空间的机器类型
列出代码空间可转换使用的机器类型。
OAuth 应用程序令牌和个人访问令牌（经典版）需要 codespace 范围才能使用此端点。
“列出代码空间的机器类型”的细粒度访问令牌
此端点适用于以下细粒度令牌类型
细粒度令牌必须具有以下权限集
- “Codespaces 元数据”存储库权限（读取）
“列出代码空间的机器类型”的参数
| 名称、类型、说明 |
|---|
accept 字符串 建议设置为 |
| 名称、类型、说明 |
|---|
codespace_name 字符串 必需代码空间的名称。 |
“列出代码空间的机器类型”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
200 | 确定 |
304 | 未修改 |
401 | 需要身份验证 |
403 | 禁止 |
404 | 未找到资源 |
500 | 内部错误 |
“列出代码空间的机器类型”的代码示例
请求示例
get/user/codespaces/{codespace_name}/machines
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/user/codespaces/CODESPACE_NAME/machines响应
状态：200{ "total_count": 2, "machines": [ { "name": "standardLinux", "display_name": "4 个内核，16 GB RAM，64 GB 存储", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 17179869184, "cpus": 4 }, { "name": "premiumLinux", "display_name": "8 个内核，32 GB RAM，64 GB 存储", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 34359738368, "cpus": 8 } ] }