- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- Examples
- Try it!
Lists all backup runs associated with the project or a given instance and configuration in the reverse chronological order of the backup initiation time.
HTTP request
GET https://sqladmin.googleapis.com/sql/v1beta4/projects/{project}/instances/{instance}/backupRuns
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID of the project that contains the instance. |
instance |
Cloud SQL instance ID, or "-" for all instances. This does not include the project ID. |
Query parameters
Parameters | |
---|---|
maxResults |
Maximum number of backup runs per response. |
pageToken |
A previously-returned page token representing part of the larger set of results to view. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
Backup run list results.
JSON representation |
---|
{
"kind": string,
"items": [
{
object ( |
Fields | |
---|---|
kind |
This is always |
items[] |
A list of backup runs in reverse chronological order of the enqueued time. |
nextPageToken |
The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. |
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/sqlservice.admin
For more information, see the Authentication Overview.
Uses the .NET client library. Uses the Go client library. Uses the Java client library. Uses the Node.js client library. Uses the PHP client library. Uses the Python client library. Uses the Ruby client library.Examples
// BEFORE RUNNING:
// ---------------
// 1. If not already done, enable the Cloud SQL Administration API
// and check the quota for your project at
// https://console.developers.google.com/apis/api/sqladmin
// 2. This sample uses Application Default Credentials for authentication.
// If not already done, install the gcloud CLI from
// https://cloud.google.com/sdk and run
// `gcloud beta auth application-default login`.
// For more information, see
// https://developers.google.com/identity/protocols/application-default-credentials
// 3. Install the C# client library by adding a dependency on the relevant NuGet
// package. Libraries published by Google are owned by google-apis-packages:
// https://www.nuget.org/profiles/google-apis-packages
using Google.Apis.Auth.OAuth2;
using Google.Apis.SQLAdmin.v1beta4;
using Google.Apis.Services;
using Newtonsoft.Json;
using System;
using System.Threading.Tasks;
using Data = Google.Apis.SQLAdmin.v1beta4.Data;
namespace SQLAdminSample
{
public class SQLAdminExample
{
public static void Main(string[] args)
{
SQLAdminService sqlAdminService = new SQLAdminService(new BaseClientService.Initializer
{
HttpClientInitializer = GetCredential(),
ApplicationName = "Google-SQLAdminSample/0.1",
});
// Project ID of the project that contains the instance.
string project = "my-project"; // TODO: Update placeholder value.
// Cloud SQL instance ID. This does not include the project ID.
string instance = "my-instance"; // TODO: Update placeholder value.
BackupRunsResource.ListRequest request = sqlAdminService.BackupRuns.List(project, instance);
Data.BackupRunsListResponse response;
do
{
// To execute asynchronously in an async method, replace `request.Execute()` as shown:
response = request.Execute();
// response = await request.ExecuteAsync();
if (response.Items == null)
{
continue;
}
foreach (Data.BackupRun backupRun in response.Items)
{
// TODO: Change code below to process each `backupRun` resource:
Console.WriteLine(JsonConvert.SerializeObject(backupRun));
}
request.PageToken = response.NextPageToken;
} while (response.NextPageToken != null);
}
public static GoogleCredential GetCredential()
{
GoogleCredential credential = Task.Run(() => GoogleCredential.GetApplicationDefaultAsync()).Result;
if (credential.IsCreateScopedRequired)
{
credential = credential.CreateScoped("https://www.googleapis.com/auth/cloud-platform");
}
return credential;
}
}
}package main
// BEFORE RUNNING:
// ---------------
// 1. If not already done, enable the Cloud SQL Administration API
// and check the quota for your project at
// https://console.developers.google.com/apis/api/sqladmin
// 2. This sample uses Application Default Credentials for authentication.
// If not already done, install the gcloud CLI from
// https://cloud.google.com/sdk/ and run
// `gcloud beta auth application-default login`.
// For more information, see
// https://developers.google.com/identity/protocols/application-default-credentials
// 3. Install and update the Go dependencies by running `go get -u` in the
// project directory.
import (
"fmt"
"log"
"golang.org/x/net/context"
"golang.org/x/oauth2/google"
"google.golang.org/api/sqladmin/v1beta4"
)
func main() {
ctx := context.Background()
c, err := google.DefaultClient(ctx, sqladmin.CloudPlatformScope)
if err != nil {
log.Fatal(err)
}
sqladminService, err := sqladmin.New(c)
if err != nil {
log.Fatal(err)
}
// Project ID of the project that contains the instance.
project := "my-project" // TODO: Update placeholder value.
// Cloud SQL instance ID. This does not include the project ID.
instance := "my-instance" // TODO: Update placeholder value.
req := sqladminService.BackupRuns.List(project, instance)
if err := req.Pages(ctx, func(page *sqladmin.BackupRunsListResponse) error {
for _, backupRun := range page.Items {
// TODO: Change code below to process each `backupRun` resource:
fmt.Printf("%#v\n", backupRun)
}
return nil
}); err != nil {
log.Fatal(err)
}
}/*
* BEFORE RUNNING:
* ---------------
* 1. If not already done, enable the Cloud SQL Administration API
* and check the quota for your project at
* https://console.developers.google.com/apis/api/sqladmin
* 2. This sample uses Application Default Credentials for authentication.
* If not already done, install the gcloud CLI from
* https://cloud.google.com/sdk and run
* `gcloud beta auth application-default login`.
* For more information, see
* https://developers.google.com/identity/protocols/application-default-credentials
* 3. Install the Java client library on Maven or Gradle. Check installation
* instructions at https://github.com/google/google-api-java-client.
* On other build systems, you can add the jar files to your project from
* https://developers.google.com/resources/api-libraries/download/sqladmin/v1beta4/java
*/
import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.JsonFactory;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.api.services.sqladmin.SQLAdmin;
import com.google.api.services.sqladmin.model.BackupRun;
import com.google.api.services.sqladmin.model.BackupRunsListResponse;
import java.io.IOException;
import java.security.GeneralSecurityException;
import java.util.Arrays;
public class SqlAdminExample {
public static void main(String args[]) throws IOException, GeneralSecurityException {
// Project ID of the project that contains the instance.
String project = "my-project"; // TODO: Update placeholder value.
// Cloud SQL instance ID. This does not include the project ID.
String instance = "my-instance"; // TODO: Update placeholder value.
SQLAdmin sqlAdminService = createSqlAdminService();
SQLAdmin.BackupRuns.List request = sqlAdminService.backupRuns().list(project, instance);
BackupRunsListResponse response;
do {
response = request.execute();
if (response.getItems() == null) {
continue;
}
for (BackupRun backupRun : response.getItems()) {
// TODO: Change code below to process each `backupRun` resource:
System.out.println(backupRun);
}
request.setPageToken(response.getNextPageToken());
} while (response.getNextPageToken() != null);
}
public static SQLAdmin createSqlAdminService() throws IOException, GeneralSecurityException {
HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
JsonFactory jsonFactory = JacksonFactory.getDefaultInstance();
GoogleCredential credential = GoogleCredential.getApplicationDefault();
if (credential.createScopedRequired()) {
credential =
credential.createScoped(Arrays.asList("https://www.googleapis.com/auth/cloud-platform"));
}
return new SQLAdmin.Builder(httpTransport, jsonFactory, credential)
.setApplicationName("Google-SQLAdminSample/0.1")
.build();
}
}// BEFORE RUNNING:
// ---------------
// 1. If not already done, enable the Cloud SQL Admin API
// and check the quota for your project at
// https://console.developers.google.com/apis/api/sqladmin
// 2. This sample uses Application Default Credentials for authentication.
// If not already done, install the gcloud CLI from
// https://cloud.google.com/sdk and run
// `gcloud beta auth application-default login`.
// For more information, see
// https://developers.google.com/identity/protocols/application-default-credentials
// 3. Install the Node.js client library by running
// `npm install googleapis --save`
const {google} = require('googleapis');
var sqlAdmin = google.sqladmin('v1beta4');
authorize(function(authClient) {
var request = {
// Project ID of the project that contains the instance.
project: 'my-project', // TODO: Update placeholder value.
// Cloud SQL instance ID. This does not include the project ID.
instance: 'my-instance', // TODO: Update placeholder value.
auth: authClient,
};
var handlePage = function(err, response) {
if (err) {
console.error(err);
return;
}
var itemsPage = response['items'];
if (!itemsPage) {
return;
}
for (var i = 0; i < itemsPage.length; i++) {
// TODO: Change code below to process each resource in `itemsPage`:
console.log(JSON.stringify(itemsPage[i], null, 2));
}
if (response.nextPageToken) {
request.pageToken = response.nextPageToken;
sqlAdmin.backupRuns.list(request, handlePage);
}
};
sqlAdmin.backupRuns.list(request, handlePage);
});
function authorize(callback) {
google.auth.getClient({
scopes: ['https://www.googleapis.com/auth/cloud-platform']
}).then(client => {
callback(client);
}).catch(err => {
console.error('authentication failed: ', err);
});
}<?php
/*
* BEFORE RUNNING:
* ---------------
* 1. If not already done, enable the Cloud SQL Administration API
* and check the quota for your project at
* https://console.developers.google.com/apis/api/sqladmin
* 2. This sample uses Application Default Credentials for authentication.
* If not already done, install the gcloud CLI from
* https://cloud.google.com/sdk and run
* `gcloud beta auth application-default login`.
* For more information, see
* https://developers.google.com/identity/protocols/application-default-credentials
* 3. Install the PHP client library with Composer. Check installation
* instructions at https://github.com/google/google-api-php-client.
*/
// Autoload Composer.
require_once __DIR__ . '/vendor/autoload.php';
$client = new Google_Client();
$client->setApplicationName('Google-SQLAdminSample/0.1');
$client->useApplicationDefaultCredentials();
$client->addScope('https://www.googleapis.com/auth/cloud-platform');
$service = new Google_Service_SQLAdmin($client);
// Project ID of the project that contains the instance.
$project = 'my-project'; // TODO: Update placeholder value.
// Cloud SQL instance ID. This does not include the project ID.
$instance = 'my-instance'; // TODO: Update placeholder value.
$optParams = [];
do {
$response = $service->backupRuns->listBackupRuns($project, $instance, $optParams);
foreach ($response['items'] as $backupRun) {
// TODO: Change code below to process each `backupRun` resource:
echo '<pre>', var_export($backupRun, true), '</pre>', "\n";
}
$optParams['pageToken'] = $response->getNextPageToken();
} while ($optParams['pageToken']);
?>"""
BEFORE RUNNING:
---------------
1. If not already done, enable the Cloud SQL Administration API
and check the quota for your project at
https://console.developers.google.com/apis/api/sqladmin
2. This sample uses Application Default Credentials for authentication.
If not already done, install the gcloud CLI from
https://cloud.google.com/sdk and run
`gcloud beta auth application-default login`.
For more information, see
https://developers.google.com/identity/protocols/application-default-credentials
3. Install the Python client library for Google APIs by running
`pip install --upgrade google-api-python-client`
"""
from pprint import pprint
from googleapiclient import discovery
from oauth2client.client import GoogleCredentials
credentials = GoogleCredentials.get_application_default()
service = discovery.build('sqladmin', 'v1beta4', credentials=credentials)
# Project ID of the project that contains the instance.
project = 'my-project' # TODO: Update placeholder value.
# Cloud SQL instance ID. This does not include the project ID.
instance = 'my-instance' # TODO: Update placeholder value.
request = service.backupRuns().list(project=project, instance=instance)
while request is not None:
response = request.execute()
for backup_run in response['items']:
# TODO: Change code below to process each `backup_run` resource:
pprint(backup_run)
request = service.backupRuns().list_next(previous_request=request, previous_response=response)# BEFORE RUNNING:
# ---------------
# 1. If not already done, enable the Cloud SQL Administration API
# and check the quota for your project at
# https://console.developers.google.com/apis/api/sqladmin
# 2. This sample uses Application Default Credentials for authentication.
# If not already done, install the gcloud CLI from
# https://cloud.google.com/sdk and run
# `gcloud beta auth application-default login`.
# For more information, see
# https://developers.google.com/identity/protocols/application-default-credentials
# 3. Install the Ruby client library and Application Default Credentials
# library by running `gem install google-api-client` and
# `gem install googleauth`
require 'googleauth'
require 'google/apis/sqladmin_v1beta4'
service = Google::Apis::SqladminV1beta4::SqlAdminService.new
service.authorization = \
Google::Auth.get_application_default(['https://www.googleapis.com/auth/cloud-platform'])
# Project ID of the project that contains the instance.
project = 'my-project' # TODO: Update placeholder value.
# Cloud SQL instance ID. This does not include the project ID.
instance = 'my-instance' # TODO: Update placeholder value.
items = service.fetch_all do |token|
service.list_backup_runs(project, instance, page_token: token)
end
items.each do |backup_run|
# TODO: Change code below to process each `backup_run` resource:
puts backup_run.to_json
end