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 | OK |
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 } ] }列出 Codespace 的机器类型
列出 Codespace 可以切换使用的机器类型。
OAuth 应用令牌和个人访问令牌（经典）需要codespace作用域才能使用此端点。
“列出 Codespace 的机器类型”的细粒度访问令牌
此端点适用于以下细粒度令牌类型:
细粒度令牌必须具有以下权限集
- “Codespaces 元数据”代码仓库权限（读取）
“列出 Codespace 的机器类型”的参数
| 名称，类型，描述 |
|---|
accept 字符串建议设置为 |
| 名称，类型，描述 |
|---|
codespace_name 字符串 必需Codespace 的名称。 |
“列出 Codespace 的机器类型”的 HTTP 响应状态代码
| 状态代码 | 描述 |
|---|---|
200 | OK |
304 | 未修改 |
401 | 需要身份验证 |
403 | 禁止 |
404 | 资源未找到 |
500 | 内部错误 |
“列出 Codespace 的机器类型”的代码示例
请求示例
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 } ] }