Method: projects.instances.backupOperations.list

Lists the backup long-running operations in the given instance. A backup operation has a name of the form projects/<project>/instances/<instance>/backups/<backup>/operations/<operation>. The long-running operation metadata field type metadata.type_url describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by operation.metadata.value.progress.start_time in descending order starting from the most recently started operation.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. The instance of the backup operations. Values are of the form projects/<project>/instances/<instance>.

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

  • spanner.backupOperations.list

Query parameters



An expression that filters the list of returned backup operations.

A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: <, >, <=, >=, !=, =, or :. Colon : is the contains operator. Filter rules are not case sensitive.

The following fields in the operation are eligible for filtering:

  • name - The name of the long-running operation
  • done - False if the operation is in progress, else true.
  • metadata.@type - the type of metadata. For example, the type string for CreateBackupMetadata is
  • metadata.<field_name> - any field in metadata.value.
  • error - Error associated with the long-running operation.
  • response.@type - the type of response.
  • response.<field_name> - any field in response.value.

You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly.

Here are a few examples:

  • done:true - The operation is complete.
  • metadata.database:prod - The database the backup was taken from has a name containing the string "prod".
  • ( AND \ ( AND \ (metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND \ (error:*) - Returns operations where:
    • The operation's metadata type is CreateBackupMetadata.
    • The backup name contains the string "howl".
    • The operation started before 2018-03-28T14:50:00Z.
    • The operation resulted in an error.


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



If non-empty, pageToken should contain a nextPageToken from a previous ListBackupOperationsResponse 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 backupOperations.list.

JSON representation
  "operations": [
      object (Operation)
  "nextPageToken": string

object (Operation)

The list of matching backup long-running operations. Each operation's name will be prefixed by the backup's name and the operation's metadata will be of type CreateBackupMetadata. Operations returned include those that are pending or have completed/failed/canceled within the last 7 days. Operations returned are ordered by operation.metadata.value.progress.start_time in descending order starting from the most recently started operation.



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

Authorization Scopes

Requires one of the following OAuth scopes:


For more information, see the Authentication Overview.