BackupRuns

Represents a backup for a Cloud SQL instance. When an instance has backups enabled, backups for the instance are performed once a day. For First Generation instances, if there is no new data since the last backup, a backupRuns resource is still created but with a status of SKIPPED. For more information about backups, see Overview of Backups.

For a list of methods for this resource, see the end of this page.

Resource representations

A BackupRun resource.

{
  "kind": "sql#backupRun",
  "id": long,
  "selfLink": string,
  "instance": string,
  "description": string,
  "windowStartTime": datetime,
  "status": string,
  "type": string,
  "enqueuedTime": datetime,
  "startTime": datetime,
  "endTime": datetime,
  "error": {
    "kind": "sql#operationError",
    "code": string,
    "message": string
  }
}
Property name Value Description Notes
description string The description of this run, only applicable to on-demand backups.
endTime datetime The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
enqueuedTime datetime The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
error nested object Information about why the backup operation failed. This is only present if the run has the FAILED status.
error.code string Identifies the specific error that occurred.
error.kind string This is always sql#operationError.
error.message string Additional information about the error encountered.
id long A unique identifier for this backup run. Note that this is unique only within the scope of a particular Cloud SQL instance.
instance string Name of the database instance.
kind string This is always sql#backupRun.
startTime datetime The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
status string The status of this run.
type string The type of this run; can be either "AUTOMATED" or "ON_DEMAND".
windowStartTime datetime The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

Methods

delete
Deletes the backup taken by a backup run.
get
Retrieves a resource containing information about a backup run.
insert
Creates a new backup run on demand. This method is applicable only to Second Generation instances.
list
Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the backup initiation time.

Send feedback about...

Cloud SQL Documentation