跳至主要内容
REST API 现在已版本化。 更多信息,请参阅“关于 API 版本控制”。

用于计费的 REST API 端点

使用 REST API 获取企业计费信息。

关于计费

您可以获取企业的计费信息。更多信息,请参阅“企业计费的 REST API 端点”。

获取组织的 GitHub Actions 计费信息

获取已使用的免费和付费 GitHub Actions 分钟数的摘要。

付费分钟数仅适用于使用 GitHub 托管运行器的私有代码仓库中的工作流程。已使用的分钟数按每个 GitHub 托管运行器操作系统列出。任何作业重新运行也包含在使用情况中。返回的使用情况包括 macOS 和 Windows 运行器的任何分钟倍数,并四舍五入到最接近的整分钟。更多信息,请参阅“管理 GitHub Actions 的计费”。

OAuth 应用令牌和个人访问令牌(经典版)需要 `repo` 或 `admin:org` 范围才能使用此端点。

“获取组织的 GitHub Actions 计费信息”的细粒度访问令牌

此端点可与以下细粒度令牌类型配合使用:

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

  • “管理”组织权限(读取)

“获取组织的 GitHub Actions 计费信息”的参数

标头
名称、类型、描述
accept 字符串

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

路径参数
名称、类型、描述
org 字符串 必需

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

“获取组织的 GitHub Actions 计费信息”的 HTTP 响应状态代码

状态代码描述
200

OK

“获取组织的 GitHub Actions 计费信息”的代码示例

请求示例

get/orgs/{org}/settings/billing/actions
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/settings/billing/actions

响应

状态:200
{ "total_minutes_used": 305, "total_paid_minutes_used": 0, "included_minutes": 3000, "minutes_used_breakdown": { "UBUNTU": 205, "MACOS": 10, "WINDOWS": 90 } }

获取组织的 GitHub Packages 计费信息

获取 GitHub Packages 中以 GB 为单位的免费和付费存储使用情况。

付费分钟数仅适用于为私有代码仓库存储的软件包。更多信息,请参阅“管理 GitHub Packages 的计费”。

OAuth 应用令牌和个人访问令牌(经典版)需要 `repo` 或 `admin:org` 范围才能使用此端点。

“获取组织的 GitHub Packages 计费信息”的细粒度访问令牌

此端点可与以下细粒度令牌类型配合使用:

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

  • “管理”组织权限(读取)

“获取组织的 GitHub Packages 计费信息”的参数

标头
名称、类型、描述
accept 字符串

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

路径参数
名称、类型、描述
org 字符串 必需

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

“获取组织的 GitHub Packages 计费信息”的 HTTP 响应状态代码

状态代码描述
200

OK

“获取组织的 GitHub Packages 计费信息”的代码示例

请求示例

get/orgs/{org}/settings/billing/packages
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/settings/billing/packages

响应

状态:200
{ "total_gigabytes_bandwidth_used": 50, "total_paid_gigabytes_bandwidth_used": 40, "included_gigabytes_bandwidth": 10 }

获取组织的共享存储计费信息

获取 GitHub Actions 和 GitHub Packages 的估计付费存储和估计总存储使用情况。

付费分钟数仅适用于为私有代码仓库存储的软件包。更多信息,请参阅“管理 GitHub Packages 的计费”。

OAuth 应用令牌和个人访问令牌(经典版)需要 `repo` 或 `admin:org` 范围才能使用此端点。

“获取组织的共享存储计费信息”的细粒度访问令牌

此端点可与以下细粒度令牌类型配合使用:

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

  • “管理”组织权限(读取)

“获取组织的共享存储计费信息”的参数

标头
名称、类型、描述
accept 字符串

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

路径参数
名称、类型、描述
org 字符串 必需

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

“获取组织的共享存储计费信息”的 HTTP 响应状态代码

状态代码描述
200

OK

“获取组织的共享存储计费信息”的代码示例

请求示例

get/orgs/{org}/settings/billing/shared-storage
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/settings/billing/shared-storage

响应

状态:200
{ "days_left_in_billing_cycle": 20, "estimated_paid_storage_for_month": 15, "estimated_storage_for_month": 40 }

获取用户的 GitHub Actions 计费信息

获取已使用的免费和付费 GitHub Actions 分钟数的摘要。

付费分钟数仅适用于使用 GitHub 托管运行器的私有代码仓库中的工作流程。已使用的分钟数按每个 GitHub 托管运行器操作系统列出。任何作业重新运行也包含在使用情况中。返回的使用情况包括 macOS 和 Windows 运行器的任何分钟倍数,并四舍五入到最接近的整分钟。更多信息,请参阅“管理 GitHub Actions 的计费”。

OAuth 应用令牌和个人访问令牌(经典版)需要 `user` 范围才能使用此端点。

“获取用户的 GitHub Actions 计费信息”的细粒度访问令牌

此端点可与以下细粒度令牌类型配合使用:

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

  • “计划”用户权限(读取)

“获取用户的 GitHub Actions 计费信息”的参数

标头
名称、类型、描述
accept 字符串

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

路径参数
名称、类型、描述
username 字符串 必需

GitHub 用户帐户的用户名。

“获取用户的 GitHub Actions 计费信息”的 HTTP 响应状态代码

状态代码描述
200

OK

“获取用户的 GitHub Actions 计费信息”的代码示例

请求示例

get/users/{username}/settings/billing/actions
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/users/USERNAME/settings/billing/actions

响应

状态:200
{ "total_minutes_used": 305, "total_paid_minutes_used": 0, "included_minutes": 3000, "minutes_used_breakdown": { "UBUNTU": 205, "MACOS": 10, "WINDOWS": 90 } }

获取用户的 GitHub Packages 计费信息

获取 GitHub Packages 中以 GB 为单位的免费和付费存储使用情况。

付费分钟数仅适用于为私有代码仓库存储的软件包。更多信息,请参阅“管理 GitHub Packages 的计费”。

OAuth 应用令牌和个人访问令牌(经典版)需要 `user` 范围才能使用此端点。

“获取用户的 GitHub Packages 计费信息”的细粒度访问令牌

此端点可与以下细粒度令牌类型配合使用:

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

  • “计划”用户权限(读取)

“获取用户的 GitHub Packages 计费信息”的参数

标头
名称、类型、描述
accept 字符串

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

路径参数
名称、类型、描述
username 字符串 必需

GitHub 用户帐户的用户名。

“获取用户的 GitHub Packages 计费信息”的 HTTP 响应状态代码

状态代码描述
200

OK

“获取用户的 GitHub Packages 计费信息”的代码示例

请求示例

get/users/{username}/settings/billing/packages
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/users/USERNAME/settings/billing/packages

响应

状态:200
{ "total_gigabytes_bandwidth_used": 50, "total_paid_gigabytes_bandwidth_used": 40, "included_gigabytes_bandwidth": 10 }

获取用户的共享存储计费信息

获取 GitHub Actions 和 GitHub Packages 的估计付费存储和估计总存储使用情况。

付费分钟数仅适用于为私有代码仓库存储的软件包。更多信息,请参阅“管理 GitHub Packages 的计费”。

OAuth 应用令牌和个人访问令牌(经典版)需要 `user` 范围才能使用此端点。

“获取用户的共享存储计费信息”的细粒度访问令牌

此端点可与以下细粒度令牌类型配合使用:

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

  • “计划”用户权限(读取)

“获取用户的共享存储计费信息”的参数

标头
名称、类型、描述
accept 字符串

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

路径参数
名称、类型、描述
username 字符串 必需

GitHub 用户帐户的用户名。

“获取用户的共享存储计费信息”的 HTTP 响应状态代码

状态代码描述
200

OK

“获取用户的共享存储计费信息”的代码示例

请求示例

get/users/{username}/settings/billing/shared-storage
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/users/USERNAME/settings/billing/shared-storage

响应

状态:200
{ "days_left_in_billing_cycle": 20, "estimated_paid_storage_for_month": 15, "estimated_storage_for_month": 40 }