REST API 概述文档描述了速率限制规则。 您可以随时使用下面描述的速率限制 API 来检查您当前的速率限制状态。
了解您的速率限制状态
搜索 API 具有自定义速率限制,与管理 REST API 其余部分的速率限制不同。 GraphQL API 也有自定义速率限制,它与 REST API 中的速率限制不同且分开计算。
出于这些原因,速率限制 API 响应对速率限制进行分类。 在资源
下,您会看到四个 对象:
-
核心
对象提供 REST API 中所有非搜索相关资源的速率限制状态。 -
搜索
对象提供搜索 API 的速率限制状态。 -
graphql
对象提供 GraphQL API 的速率限制状态。 -
integration_manifest
对象提供 GitHub 应用程序清单代码转换端点的速率限制状态。
有关速率限制响应中标头和值的更多信息,请参阅“速率限制”。
Get rate limit status for the authenticated user
Note: Accessing this endpoint does not count against your REST API rate limit.
Note: The rate
object is deprecated. If you're writing new API client code or updating existing code, you should use the core
object instead of the rate
object. The core
object contains the same information that is present in the rate
object.
get /rate_limit
代码示例
Shell
curl \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/rate_limit
JavaScript (@octokit/core.js)
await octokit.request('GET /rate_limit')
Default response
Status: 200 OK
{
"resources": {
"core": {
"limit": 5000,
"remaining": 4999,
"reset": 1372700873
},
"search": {
"limit": 30,
"remaining": 18,
"reset": 1372697452
},
"graphql": {
"limit": 5000,
"remaining": 4993,
"reset": 1372700389
},
"integration_manifest": {
"limit": 5000,
"remaining": 4999,
"reset": 1551806725
},
"code_scanning_upload": {
"limit": 500,
"remaining": 499,
"reset": 1551806725
}
},
"rate": {
"limit": 5000,
"remaining": 4999,
"reset": 1372700873
}
}
Not modified
Status: 304 Not Modified
Resource not found
Status: 404 Not Found