- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- Try it!
Lists the existing snapshots. Snapshots are used in [subscriptions.seek]( https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.
HTTP request
GET https://pubsub.googleapis.com/v1/{project}/snapshots
Path parameters
Parameters | |
---|---|
project |
Required. The name of the project in which to list snapshots. Format is |
Query parameters
Parameters | |
---|---|
pageSize |
Maximum number of snapshots to return. |
pageToken |
The value returned by the last |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
Response for the snapshots.list
method.
JSON representation |
---|
{
"snapshots": [
{
object ( |
Fields | |
---|---|
snapshots[] |
The resulting snapshots. |
nextPageToken |
If not empty, indicates that there may be more snapshot that match the request; this value should be passed in a new |
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/pubsub
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.