REST API 现在已实现版本控制。 更多信息，请参阅“关于 API 版本控制”。

GitHub Actions 缓存的 REST API 端点

使用 REST API 与 GitHub Actions 中的代码仓库缓存进行交互。

关于 GitHub Actions 中的缓存

您可以使用 REST API 查询和管理 GitHub Actions 中代码仓库的缓存。您还可以安装 GitHub CLI 扩展程序，以便通过命令行管理您的缓存。更多信息，请参阅“缓存依赖项以加快工作流程速度”。

获取组织的 GitHub Actions 缓存使用情况

获取组织的 GitHub Actions 缓存总使用情况。使用此 API 获取的数据大约每 5 分钟刷新一次，因此此端点返回的值可能需要至少 5 分钟才能更新。

OAuth 令牌和个人访问令牌（传统）需要 `read:org` 范围才能使用此端点。

“获取组织的 GitHub Actions 缓存使用情况”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “管理”组织权限（读取）

“获取组织的 GitHub Actions 缓存使用情况”的参数

标头
accept 字符串

建议设置为 `application/vnd.github+json`。

路径参数
org 字符串 必需

组织名称。名称不区分大小写。

“获取组织的 GitHub Actions 缓存使用情况”的 HTTP 响应状态码

状态码描述
200

OK

“获取组织的 GitHub Actions 缓存使用情况”的代码示例

请求示例

get/orgs/{org}/actions/cache/usage
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/orgs/ORG/actions/cache/usage

响应

状态：200
{ "total_active_caches_size_in_bytes": 3344284, "total_active_caches_count": 5 }

列出具有 GitHub Actions 缓存使用情况的组织的代码仓库

列出组织及其 GitHub Actions 缓存使用情况的代码仓库。使用此 API 获取的数据大约每 5 分钟刷新一次，因此此端点返回的值可能需要至少 5 分钟才能更新。

OAuth 令牌和个人访问令牌（传统）需要 `read:org` 范围才能使用此端点。

“列出具有 GitHub Actions 缓存使用情况的组织的代码仓库”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “管理”组织权限（读取）

“列出具有 GitHub Actions 缓存使用情况的组织的代码仓库”的参数

标头
accept 字符串

建议设置为 `application/vnd.github+json`。

路径参数
org 字符串 必需

组织名称。名称不区分大小写。

查询参数
per_page 整数

每页的结果数（最多 100）。更多信息，请参阅“在 REST API 中使用分页”。

默认值： 30

page 整数

要获取的结果的页码。更多信息，请参阅“在 REST API 中使用分页”。

默认值： 1

“列出具有 GitHub Actions 缓存使用情况的组织的代码仓库”的 HTTP 响应状态码

状态码描述
200

OK

“列出具有 GitHub Actions 缓存使用情况的组织的代码仓库”的代码示例

请求示例

get/orgs/{org}/actions/cache/usage-by-repository
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/orgs/ORG/actions/cache/usage-by-repository

响应

状态：200
{ "total_count": 2, "repository_cache_usages": [ { "full_name": "octo-org/Hello-World", "active_caches_size_in_bytes": 2322142, "active_caches_count": 3 }, { "full_name": "octo-org/server", "active_caches_size_in_bytes": 1022142, "active_caches_count": 2 } ] }

获取代码仓库的 GitHub Actions 缓存使用情况

获取代码仓库的 GitHub Actions 缓存使用情况。使用此 API 获取的数据大约每 5 分钟刷新一次，因此此端点返回的值可能需要至少 5 分钟才能更新。

任何具有代码仓库读取权限的用户都可以使用此端点。

如果代码仓库是私有的，则 OAuth 令牌和个人访问令牌（传统）需要 `repo` 范围才能使用此端点。

“获取代码仓库的 GitHub Actions 缓存使用情况”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “Actions”代码仓库权限（读取）

如果仅请求公共资源，则无需身份验证或上述权限即可使用此端点。

“获取代码仓库的 GitHub Actions 缓存使用情况”的参数

标头
accept 字符串

建议设置为 `application/vnd.github+json`。

路径参数
owner 字符串 必需

代码仓库的帐户所有者。名称不区分大小写。

repo 字符串 必需

不包含 `.git` 扩展名的代码仓库名称。名称不区分大小写。

“获取代码仓库的 GitHub Actions 缓存使用情况”的 HTTP 响应状态码

状态码描述
200

OK

“获取代码仓库的 GitHub Actions 缓存使用情况”的代码示例

请求示例

get/repos/{owner}/{repo}/actions/cache/usage
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/actions/cache/usage

响应

状态：200
{ "full_name": "octo-org/Hello-World", "active_caches_size_in_bytes": 2322142, "active_caches_count": 3 }

列出代码仓库的 GitHub Actions 缓存

列出代码仓库的 GitHub Actions 缓存。

OAuth 令牌和个人访问令牌（传统）需要 `repo` 范围才能使用此端点。

“列出代码仓库的 GitHub Actions 缓存”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “Actions”代码仓库权限（读取）

如果仅请求公共资源，则无需身份验证或上述权限即可使用此端点。

“列出代码仓库的 GitHub Actions 缓存”的参数

标头
accept 字符串

建议设置为 `application/vnd.github+json`。

路径参数
owner 字符串 必需

代码仓库的帐户所有者。名称不区分大小写。

repo 字符串 必需

不包含 `.git` 扩展名的代码仓库名称。名称不区分大小写。

查询参数
per_page 整数

每页的结果数（最多 100）。更多信息，请参阅“在 REST API 中使用分页”。

默认值： 30

page 整数

要获取的结果的页码。更多信息，请参阅“在 REST API 中使用分页”。

默认值： 1

ref 字符串

用于缩小缓存范围的完整 Git 引用。分支的 `ref` 应格式化为 `refs/heads/<branch name>`。要引用拉取请求，请使用 `refs/pull/<number>/merge`。

key 字符串

用于标识缓存的显式密钥或前缀

sort 字符串

要按其排序结果的属性。`created_at` 表示缓存创建的时间。`last_accessed_at` 表示上次访问缓存的时间。`size_in_bytes` 是缓存的大小（以字节为单位）。

默认值： last_accessed_at

可以是以下之一： created_at，last_accessed_at，size_in_bytes

direction 字符串

要按其排序结果的方向。

默认值： desc

可以是以下之一： asc，desc

“列出代码仓库的 GitHub Actions 缓存”的 HTTP 响应状态码

状态码描述
200

OK

“列出代码仓库的 GitHub Actions 缓存”的代码示例

请求示例

get/repos/{owner}/{repo}/actions/caches
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/actions/caches

响应

状态：200
{ "total_count": 1, "actions_caches": [ { "id": 505, "ref": "refs/heads/main", "key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b", "version": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0", "last_accessed_at": "2019-01-24T22:45:36.000Z", "created_at": "2019-01-24T22:45:36.000Z", "size_in_bytes": 1024 } ] }

删除代码仓库的 GitHub Actions 缓存（使用缓存密钥）

使用完整的缓存密钥删除代码仓库的一个或多个 GitHub Actions 缓存。默认情况下，将删除与提供的密钥匹配的所有缓存，但您可以选择提供 Git 引用，以将删除限制为与提供的密钥和 Git 引用都匹配的缓存。

OAuth 令牌和个人访问令牌（传统）需要 `repo` 范围才能使用此端点。

针对“删除 GitHub Actions 仓库缓存（使用缓存键）”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “Actions” 仓库权限（写入）

“删除 GitHub Actions 仓库缓存（使用缓存键）”的参数

标头
accept 字符串

建议设置为 `application/vnd.github+json`。

路径参数
owner 字符串 必需

代码仓库的帐户所有者。名称不区分大小写。

repo 字符串 必需

不包含 `.git` 扩展名的代码仓库名称。名称不区分大小写。

查询参数
key 字符串 必填

用于标识缓存的键。

ref 字符串

用于缩小缓存范围的完整 Git 引用。分支的 `ref` 应格式化为 `refs/heads/<branch name>`。要引用拉取请求，请使用 `refs/pull/<number>/merge`。

“删除 GitHub Actions 仓库缓存（使用缓存键）”的 HTTP 响应状态码

状态码描述
200

OK

“删除 GitHub Actions 仓库缓存（使用缓存键）”的代码示例

请求示例

删除/repos/{owner}/{repo}/actions/caches
curl -L \ -X DELETE \ -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/actions/caches?key=Linux-node-958aff96db2d75d67787d1e634ae70b659de937b"

响应

状态：200
{ "total_count": 1, "actions_caches": [ { "id": 505, "ref": "refs/heads/main", "key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b", "version": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0", "last_accessed_at": "2019-01-24T22:45:36.000Z", "created_at": "2019-01-24T22:45:36.000Z", "size_in_bytes": 1024 } ] }

删除 GitHub Actions 仓库缓存（使用缓存 ID）

使用缓存 ID 删除 GitHub Actions 仓库缓存。

OAuth 令牌和个人访问令牌（传统）需要 `repo` 范围才能使用此端点。

针对“删除 GitHub Actions 仓库缓存（使用缓存 ID）”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “Actions” 仓库权限（写入）

“删除 GitHub Actions 仓库缓存（使用缓存 ID）”的参数

标头
accept 字符串

建议设置为 `application/vnd.github+json`。

路径参数
owner 字符串 必需

代码仓库的帐户所有者。名称不区分大小写。

repo 字符串 必需

不包含 `.git` 扩展名的代码仓库名称。名称不区分大小写。

cache_id 整数 必填

GitHub Actions 缓存的唯一标识符。

“删除 GitHub Actions 仓库缓存（使用缓存 ID）”的 HTTP 响应状态码

状态码描述
204

无内容

“删除 GitHub Actions 仓库缓存（使用缓存 ID）”的代码示例

请求示例

删除/repos/{owner}/{repo}/actions/caches/{cache_id}
curl -L \ -X DELETE \ -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/actions/caches/CACHE_ID

响应

状态：204