Method: projects.locations.backupCollections.list

Lists all backup collections owned by a consumer project in either the specified location (region) or all locations.

If locationId is specified as - (wildcard), then all regions available to the project are queried, and the results are aggregated.

HTTP request

GET https://memorystore.googleapis.com/v1/{parent=projects/*/locations/*}/backupCollections

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the backupCollection location using the form: projects/{projectId}/locations/{locationId} where locationId refers to a Google Cloud region.

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of items to return.

If not specified, a default value of 1000 will be used by the service. Regardless of the pageSize value, the response may include a partial list and a caller should only rely on response's nextPageToken to determine if there are more clusters left to be queried.
pageToken

string

Optional. The nextPageToken value returned from a previous [backupCollections.list] request, if any.

Request body

The request body must be empty.

Response body

Response for [backupCollections.list].

If successful, the response body contains data with the following structure:

JSON representation 
{
  "backupCollections": [
    {
      object (BackupCollection)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Fields
backupCollections[]

object (BackupCollection)

A list of backupCollections in the project.

If the locationId in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a placeholder backupCollection entry is included in the response with the name field set to a value of the form projects/{projectId}/locations/{locationId}/backupCollections/- and the status field set to ERROR and statusMessage field set to "location not available for backupCollections.list".
nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.
unreachable[]

string

Locations that could not be reached.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

IAM Permissions

Requires the following IAM permission on the parent resource:

  • memorystore.backupCollections.list

For more information, see the IAM documentation.