Method: projects.instances.clusters.backups.list

Lists Cloud Bigtable backups. Returns both completed and pending backups.

HTTP request

GET https://bigtableadmin.googleapis.com/v2/{parent=projects/*/instances/*/clusters/*}/backups

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The cluster to list backups from. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}. Use {cluster} = '-' to list backups for all clusters in an instance, e.g., projects/{project}/instances/{instance}/clusters/-.

Authorization requires the following IAM permission on the specified resource parent:

  • bigtable.backups.list

Query parameters

Parameters
filter

string

A filter expression that filters backups listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be <, >, <=, >=, !=, =, or :. Colon ':' represents a HAS operator which is roughly synonymous with equality. Filter rules are case insensitive.

The fields eligible for filtering are: * name * sourceTable * state * startTime (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * endTime (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * expireTime (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * sizeBytes

To filter on multiple expressions, provide each separate expression within parentheses. By default, each expression is an AND expression. However, you can include AND, OR, and NOT expressions explicitly.

Some examples of using filters are:

  • name:"exact" --> The backup's name is the string "exact".
  • name:howl --> The backup's name contains the string "howl".
  • sourceTable:prod --> The sourceTable's name contains the string "prod".
  • state:CREATING --> The backup is pending creation.
  • state:READY --> The backup is fully created and ready for use.
  • (name:howl) AND (startTime < \"2018-03-28T14:50:00Z\") --> The backup name contains the string "howl" and startTime of the backup is before 2018-03-28T14:50:00Z.
  • sizeBytes > 10000000000 --> The backup's size is greater than 10GB
orderBy

string

An expression for specifying the sort order of the results of the request. The string value should specify one or more fields in Backup. The full syntax is described at https://aip.dev/132#ordering.

Fields supported are: * name * sourceTable * expireTime * startTime * endTime * sizeBytes * state

For example, "startTime". The default sorting order is ascending. To specify descending order for the field, a suffix " desc" should be appended to the field name. For example, "startTime desc". Redundant space characters in the syntax are insigificant.

If orderBy is empty, results will be sorted by startTime in descending order starting from the most recently created backup.

pageSize

integer

Number of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

pageToken

string

If non-empty, pageToken should contain a nextPageToken from a previous ListBackupsResponse to the same parent and with the same filter.

Request body

The request body must be empty.

Response body

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

The response for backups.list.

JSON representation
{
  "backups": [
    {
      object (Backup)
    }
  ],
  "nextPageToken": string
}
Fields
backups[]

object (Backup)

The list of matching backups.

nextPageToken

string

nextPageToken can be sent in a subsequent backups.list call to fetch more of the matching backups.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.