View backups for an Autonomous Database

This page describes how to view backups for an Autonomous Database using the Oracle Database@Google Cloud API or Google Cloud CLI.

Autonomous Database lets you create automatic backups of your data that can be used to restore lost data or provide protection against errors. Backups are highly available and are stored for the retention period defined in your Autonomous Database's settings.

In Oracle Database@Google Cloud, Autonomous Database backup retention is set in days and can range from 1 to 60 days, with a default value of 60 days. The retention period is set when you create a database and can't be modified in Google Cloud after creation. To modify the retention period in OCI, see About Backup and Recovery on Autonomous Database.

Backups beyond the set retention period are automatically deleted. Automatic backups are managed by Oracle Cloud Infrastructure (OCI) and billed separately, in addition to database storage.

To see your database's backup settings, View database information.

To learn more about how backup and recovery works for an Autonomous Database, see About Backup and Recovery on Autonomous Database.

View backups for an Autonomous Database

To view available backups for an Autonomous Database, follow these steps:

gcloud

Run the gcloud oracle-database autonomous-database-backups list command:

gcloud oracle-database autonomous-database-backups list
--filter='autonomous_database_id="DATABASE_NAME"'
--location=REGION_ID
--project=PROJECT_NAME

Replace the following:

• DATABASE_NAME: name of the database you want to view backups for.
• REGION_ID: the region of your database.
• PROJECT_NAME: the name of your Google Cloud project.

C#

using Google.Api.Gax;
using Google.Cloud.OracleDatabase.V1;
using System;
using System.Linq;
using System.Threading.Tasks;

public sealed partial class GeneratedOracleDatabaseClientSnippets
{
    /// <summary>Snippet for ListAutonomousDatabaseBackupsAsync</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public async Task ListAutonomousDatabaseBackupsAsync()
    {
        // Create client
        OracleDatabaseClient oracleDatabaseClient = await OracleDatabaseClient.CreateAsync();
        // Initialize request argument(s)
        string parent = "projects/[PROJECT]/locations/[LOCATION]";
        // Make the request
        PagedAsyncEnumerable<ListAutonomousDatabaseBackupsResponse, AutonomousDatabaseBackup> response = oracleDatabaseClient.ListAutonomousDatabaseBackupsAsync(parent);

        // Iterate over all response items, lazily performing RPCs as required
        await response.ForEachAsync((AutonomousDatabaseBackup item) =>
        {
            // Do something with each item
            Console.WriteLine(item);
        });

        // Or iterate over pages (of server-defined size), performing one RPC per page
        await response.AsRawResponses().ForEachAsync((ListAutonomousDatabaseBackupsResponse page) =>
        {
            // Do something with each page of items
            Console.WriteLine("A page of results:");
            foreach (AutonomousDatabaseBackup item in page)
            {
                // Do something with each item
                Console.WriteLine(item);
            }
        });

        // Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
        int pageSize = 10;
        Page<AutonomousDatabaseBackup> singlePage = await response.ReadPageAsync(pageSize);
        // Do something with the page of items
        Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
        foreach (AutonomousDatabaseBackup item in singlePage)
        {
            // Do something with each item
            Console.WriteLine(item);
        }
        // Store the pageToken, for when the next page is required.
        string nextPageToken = singlePage.NextPageToken;
    }
}

Go

package main

import (
	"context"

	oracledatabase "cloud.google.com/go/oracledatabase/apiv1"
	oracledatabasepb "cloud.google.com/go/oracledatabase/apiv1/oracledatabasepb"
	"google.golang.org/api/iterator"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := oracledatabase.NewRESTClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &oracledatabasepb.ListAutonomousDatabaseBackupsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/oracledatabase/apiv1/oracledatabasepb#ListAutonomousDatabaseBackupsRequest.
	}
	it := c.ListAutonomousDatabaseBackups(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp

		// If you need to access the underlying RPC response,
		// you can do so by casting the `Response` as below.
		// Otherwise, remove this line. Only populated after
		// first call to Next(). Not safe for concurrent access.
		_ = it.Response.(*oracledatabasepb.ListAutonomousDatabaseBackupsResponse)
	}
}

Java

import com.google.api.core.ApiFuture;
import com.google.cloud.oracledatabase.v1.AutonomousDatabaseBackup;
import com.google.cloud.oracledatabase.v1.ListAutonomousDatabaseBackupsRequest;
import com.google.cloud.oracledatabase.v1.LocationName;
import com.google.cloud.oracledatabase.v1.OracleDatabaseClient;

public class AsyncListAutonomousDatabaseBackups {

  public static void main(String[] args) throws Exception {
    asyncListAutonomousDatabaseBackups();
  }

  public static void asyncListAutonomousDatabaseBackups() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (OracleDatabaseClient oracleDatabaseClient = OracleDatabaseClient.create()) {
      ListAutonomousDatabaseBackupsRequest request =
          ListAutonomousDatabaseBackupsRequest.newBuilder()
              .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
              .setFilter("filter-1274492040")
              .setPageSize(883849137)
              .setPageToken("pageToken873572522")
              .build();
      ApiFuture<AutonomousDatabaseBackup> future =
          oracleDatabaseClient.listAutonomousDatabaseBackupsPagedCallable().futureCall(request);
      // Do something.
      for (AutonomousDatabaseBackup element : future.get().iterateAll()) {
        // doThingsWith(element);
      }
    }
  }
}

Node.js

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The parent value for ListAutonomousDatabaseBackups in the
 *  following format: projects/{project}/locations/{location}.
 */
// const parent = 'abc123'
/**
 *  Optional. An expression for filtering the results of the request. Only the
 *  **autonomous_database_id** field is supported in the following format:
 *  `autonomous_database_id="{autonomous_database_id}"`. The accepted values
 *  must be a valid Autonomous Database ID, limited to the naming
 *  restrictions of the ID: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$).
 *  The ID must start with a letter, end with a letter or a number, and be
 *  a maximum of 63 characters.
 */
// const filter = 'abc123'
/**
 *  Optional. The maximum number of items to return.
 *  If unspecified, at most 50 Autonomous DB Backups will be returned.
 *  The maximum value is 1000; values above 1000 will be coerced to 1000.
 */
// const pageSize = 1234
/**
 *  Optional. A token identifying a page of results the server should return.
 */
// const pageToken = 'abc123'

// Imports the Oracledatabase library
const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

// Instantiates a client
const oracledatabaseClient = new OracleDatabaseClient();

async function callListAutonomousDatabaseBackups() {
  // Construct request
  const request = {
    parent,
  };

  // Run request
  const iterable = oracledatabaseClient.listAutonomousDatabaseBackupsAsync(request);
  for await (const response of iterable) {
      console.log(response);
  }
}

callListAutonomousDatabaseBackups();

PHP

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\ListAutonomousDatabaseBackupsRequest;

/**
 * Lists the long-term and automatic backups of an Autonomous Database.
 *
 * @param string $formattedParent The parent value for ListAutonomousDatabaseBackups in the
 *                                following format: projects/{project}/locations/{location}. Please see
 *                                {@see OracleDatabaseClient::locationName()} for help formatting this field.
 */
function list_autonomous_database_backups_sample(string $formattedParent): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new ListAutonomousDatabaseBackupsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $oracleDatabaseClient->listAutonomousDatabaseBackups($request);

        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::locationName('[PROJECT]', '[LOCATION]');

    list_autonomous_database_backups_sample($formattedParent);
}

Python

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oracledatabase_v1


def sample_list_autonomous_database_backups():
    # Create a client
    client = oracledatabase_v1.OracleDatabaseClient()

    # Initialize request argument(s)
    request = oracledatabase_v1.ListAutonomousDatabaseBackupsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_autonomous_database_backups(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Ruby

require "google/cloud/oracle_database/v1"

##
# Snippet for the list_autonomous_database_backups call in the OracleDatabase service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client#list_autonomous_database_backups.
#
def list_autonomous_database_backups
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::OracleDatabase::V1::ListAutonomousDatabaseBackupsRequest.new

  # Call the list_autonomous_database_backups method.
  result = client.list_autonomous_database_backups request

  # The returned object is of type Gapic::PagedEnumerable. You can iterate
  # over elements, and API calls will be issued to fetch pages as needed.
  result.each do |item|
    # Each element is of type ::Google::Cloud::OracleDatabase::V1::AutonomousDatabaseBackup.
    p item
  end
end

What's next

• Restore an Autonomous Database from backup