docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update rate limit examples to use HEAD (#11707) 

* Update rate limit examples to use HEAD

* More specific

* Improvements per feedback

* More feedback

* Don't ignore errors
This commit is contained in:
Brett Inman 2020-11-05 12:50:58 -08:00 committed by GitHub
parent 0492b1ca16
commit 0a951c5204
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docker-hub/download-rate-limit.md
View File

@ -40,14 +40,14 @@ You will see this error message in the Docker CLI or in the Docker Engine logs.
## How can I check my current rate
When limiting starts, valid non-rate-limited manifest API requests to Hub will include the following rate limit headers in the response:
Valid manifest API requests to Hub will usually include the following rate limit headers in the response:
```
RateLimit-Limit
RateLimit-Remaining
```
If you have a proxy or other layer in place that logs your requests, you can inspect the headers of these responses directly. Otherwise, you can use curl to view these. You will need `curl`, `grep`, and `jq` installed.
These headers will be returned on both GET and HEAD requests. Note that using GET emulates a real pull and will count towards the limit; using HEAD will not, so we will use it in this example. To check your limits, you will need `curl`, `grep`, and `jq` installed.
To get a token anonymously (if you are pulling anonymously):
@ -61,23 +61,27 @@ To get a token with a user account (if you are authenticating your pulls) - don'
$ TOKEN=$(curl --user 'username:password' "https://auth.docker.io/token?service=registry.docker.io&scope=repository:ratelimitpreview/test:pull" | jq -r .token)
```
Then to get the headers showing your limits, run the following (keep in mind that requesting a manifest emulates a pull and will count against the limits):
Then to get the headers showing your limits, run the following:
```
$ curl -v -H "Authorization: Bearer $TOKEN" https://registry-1.docker.io/v2/ratelimitpreview/test/manifests/latest 2>&1 | grep RateLimit
$ curl --head -H "Authorization: Bearer $TOKEN" https://registry-1.docker.io/v2/ratelimitpreview/test/manifests/latest
```
Which should return something like this:
Which should return headers including these:
```
< RateLimit-Limit: 100;w=21600
< RateLimit-Remaining: 76;w=21600
RateLimit-Limit: 100;w=21600
RateLimit-Remaining: 76;w=21600
```
This means my limit is 100 per 21600 seconds (6 hours), and I have 76 pulls remaining.
> Remember that these headers are best-effort and there will be small variations.
### I don't see any RateLimit headers
If you do not see these headers, that means pulling that image would not count towards pull limits. This could be because you are authenticated with a user associated with a Legacy/Pro/Team Docker Hub account, or because the image or your IP is unlimited in partnership with a publisher, provider, or open source organization.
## How do I authenticate pull requests
The following section contains information on how to log into on Docker Hub to authenticate pull requests.