REST Resource: backupRuns

Resource: BackupRun

A BackupRun resource.

JSON representation
{
  "kind": string,
  "status": enum (SqlBackupRunStatus),
  "enqueuedTime": string,
  "id": string,
  "startTime": string,
  "endTime": string,
  "error": {
    object (OperationError)
  },
  "type": enum (SqlBackupRunType),
  "description": string,
  "windowStartTime": string,
  "instance": string,
  "selfLink": string,
  "location": string,
  "diskEncryptionConfiguration": {
    object (DiskEncryptionConfiguration)
  },
  "diskEncryptionStatus": {
    object (DiskEncryptionStatus)
  }
}
Fields
kind

string

This is always

sql#backupRun

.

status

enum (SqlBackupRunStatus)

The status of this run.

enqueuedTime

string (Timestamp format)

The time the run was enqueued in UTC timezone in RFC 3339 format, for example

2012-11-15T16:19:00.094Z

.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

id

string (int64 format)

The identifier for this backup run. Unique only for a specific Cloud SQL instance.

startTime

string (Timestamp format)

The time the backup operation actually started in UTC timezone in RFC 3339 format, for example

2012-11-15T16:19:00.094Z

.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

The time the backup operation completed in UTC timezone in RFC 3339 format, for example

2012-11-15T16:19:00.094Z

.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

error

object (OperationError)

Information about why the backup operation failed. This is only present if the run has the FAILED status.

type

enum (SqlBackupRunType)

The type of this run; can be either "AUTOMATED" or "ON_DEMAND".

description

string

The description of this run, only applicable to on-demand backups.

windowStartTime

string (Timestamp format)

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

.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

instance

string

Name of the database instance.

location

string

Location of the backups.

diskEncryptionConfiguration

object (DiskEncryptionConfiguration)

Encryption configuration specific to a backup. Applies only to Second Generation instances.

diskEncryptionStatus

object (DiskEncryptionStatus)

Encryption status specific to a backup. Applies only to Second Generation instances.

SqlBackupRunStatus

The status of a backup run.

Enums
SQL_BACKUP_RUN_STATUS_UNSPECIFIED The status of the run is unknown.
ENQUEUED The backup operation was enqueued.
OVERDUE The backup is overdue across a given backup window. Indicates a problem. Example: Long-running operation in progress during the whole window.
RUNNING The backup is in progress.
FAILED The backup failed.
SUCCESSFUL The backup was successful.
SKIPPED The backup was skipped (without problems) for a given backup window. Example: Instance was idle.
DELETION_PENDING The backup is about to be deleted.
DELETION_FAILED The backup deletion failed.
DELETED The backup has been deleted.

SqlBackupRunType

Enums
SQL_BACKUP_RUN_TYPE_UNSPECIFIED This is an unknown BackupRun type.
AUTOMATED The backup schedule automatically triggers a backup.
ON_DEMAND The user manually triggers a backup.

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.

list

Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the backup initiation time.
Was this page helpful? Let us know how we did:

Send feedback about...

Cloud SQL for PostgreSQL
Need help? Visit our support page.