Pauses a cache instance in a specified bucket.
When you pause a cache instance, data entries can no longer be ingested into
the cache. The existing data held in the cache is evicted when the time to live
(TTL) ends. Once paused, the cache can be unpaused by using the
storage.anywhereCaches.resume API.
Required permissions
The authenticated user must have the storage.anywhereCaches.pause IAM permission on the bucket to use this method.
Request
HTTP request
POST https://storage.googleapis.com/storage/v1/b/bucket/anywhereCaches/anywhereCacheID/pause
In addition to standard query parameters, the following parameters apply to this method.
To see an example of how to include parameters in a request, see the JSON API Overview page.
Parameters
| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
bucket |
string |
Name of a bucket. |
anywhereCacheID |
string |
A value that, along with the bucket's name, uniquely identifies the cache. |
Request body
Do not supply a request body with this method.
Response
If successful, this method returns an AnywhereCache resource.