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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-08 UTC."],[[["\u003cp\u003eThis endpoint lists Cloud Bigtable backups, including both completed and pending backups.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires specifying the parent cluster in the URL path, and you can list backups for all clusters in an instance by using \u003ccode\u003e{cluster} = '-'\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eYou can filter the list of backups by various fields such as \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003esourceTable\u003c/code\u003e, \u003ccode\u003estate\u003c/code\u003e, \u003ccode\u003estartTime\u003c/code\u003e, \u003ccode\u003eendTime\u003c/code\u003e, \u003ccode\u003eexpireTime\u003c/code\u003e, and \u003ccode\u003esizeBytes\u003c/code\u003e using the \u003ccode\u003efilter\u003c/code\u003e query parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eorderBy\u003c/code\u003e query parameter enables sorting the backups by fields such as \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003esourceTable\u003c/code\u003e, \u003ccode\u003eexpireTime\u003c/code\u003e, \u003ccode\u003estartTime\u003c/code\u003e, \u003ccode\u003eendTime\u003c/code\u003e, \u003ccode\u003esizeBytes\u003c/code\u003e, and \u003ccode\u003estate\u003c/code\u003e, in either ascending or descending order.\u003c/p\u003e\n"],["\u003cp\u003eThe server's maximum allowed page size is used if the \u003ccode\u003epageSize\u003c/code\u003e is 0 or less, and the \u003ccode\u003epageToken\u003c/code\u003e can be utilized to retrieve subsequent pages of results.\u003c/p\u003e\n"]]],[],null,[]]
