Skip to main content

backup_runs

Creates, updates, deletes, gets or lists a backup_runs resource.

Overview​

Namebackup_runs
TypeResource
Idgoogle.sqladmin.backup_runs

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstring (int64)The identifier for this backup run. Unique only for a specific Cloud SQL instance.
backupKindstringSpecifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT. (SQL_BACKUP_KIND_UNSPECIFIED, SNAPSHOT, PHYSICAL)
databaseVersionstringOutput only. The instance database version at the time this backup was made. (SQL_DATABASE_VERSION_UNSPECIFIED, MYSQL_5_1, MYSQL_5_5, MYSQL_5_6, MYSQL_5_7, MYSQL_8_0, MYSQL_8_0_18, MYSQL_8_0_26, MYSQL_8_0_27, MYSQL_8_0_28, MYSQL_8_0_29, MYSQL_8_0_30, MYSQL_8_0_31, MYSQL_8_0_32, MYSQL_8_0_33, MYSQL_8_0_34, MYSQL_8_0_35, MYSQL_8_0_36, MYSQL_8_0_37, MYSQL_8_0_39, MYSQL_8_0_40, MYSQL_8_0_41, MYSQL_8_0_42, MYSQL_8_0_43, MYSQL_8_0_44, MYSQL_8_0_45, MYSQL_8_0_46, MYSQL_8_4, MYSQL_9_7, SQLSERVER_2017_STANDARD, SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, SQLSERVER_2017_WEB, POSTGRES_9_6, POSTGRES_10, POSTGRES_11, POSTGRES_12, POSTGRES_13, POSTGRES_14, POSTGRES_15, POSTGRES_16, POSTGRES_17, POSTGRES_18, POSTGRES_19, POSTGRES_20, SQLSERVER_2019_STANDARD, SQLSERVER_2019_ENTERPRISE, SQLSERVER_2019_EXPRESS, SQLSERVER_2019_WEB, SQLSERVER_2022_STANDARD, SQLSERVER_2022_ENTERPRISE, SQLSERVER_2022_EXPRESS, SQLSERVER_2022_WEB, SQLSERVER_2025_STANDARD, SQLSERVER_2025_ENTERPRISE, SQLSERVER_2025_EXPRESS)
descriptionstringThe description of this run, only applicable to on-demand backups.
diskEncryptionConfigurationobjectEncryption configuration specific to a backup. (id: DiskEncryptionConfiguration)
diskEncryptionStatusobjectEncryption status specific to a backup. (id: DiskEncryptionStatus)
endTimestring (google-datetime)The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
enqueuedTimestring (google-datetime)The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
errorobjectInformation about why the backup operation failed. This is only present if the run has the FAILED status. (id: OperationError)
instancestringName of the database instance.
kindstringThis is always sql#backupRun.
locationstringLocation of the backups.
maxChargeableBytesstring (int64)Output only. The maximum chargeable bytes for the backup.
selfLinkstringThe URI of this resource.
startTimestring (google-datetime)The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
statusstringThe status of this run. (SQL_BACKUP_RUN_STATUS_UNSPECIFIED, ENQUEUED, OVERDUE, RUNNING, FAILED, SUCCESSFUL, SKIPPED, DELETION_PENDING, DELETION_FAILED, DELETED)
timeZonestringBackup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.
typestringThe type of this run; can be either "AUTOMATED" or "ON_DEMAND" or "FINAL". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests. (SQL_BACKUP_RUN_TYPE_UNSPECIFIED, AUTOMATED, ON_DEMAND)
windowStartTimestring (google-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​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectproject, instance, idRetrieves a resource containing information about a backup run.
listselectproject, instancemaxResults, pageTokenLists all backup runs associated with the project or a given instance and configuration in the reverse chronological order of the backup initiation time.
insertinsertproject, instanceCreates a new backup run on demand.
deletedeleteproject, instance, idDeletes the backup taken by a backup run.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
idstring
instancestring
projectstring
maxResultsinteger (int32)
pageTokenstring

SELECT examples​

Retrieves a resource containing information about a backup run.

SELECT
id,
backupKind,
databaseVersion,
description,
diskEncryptionConfiguration,
diskEncryptionStatus,
endTime,
enqueuedTime,
error,
instance,
kind,
location,
maxChargeableBytes,
selfLink,
startTime,
status,
timeZone,
type,
windowStartTime
FROM google.sqladmin.backup_runs
WHERE project = '{{ project }}' -- required
AND instance = '{{ instance }}' -- required
AND id = '{{ id }}' -- required
;

INSERT examples​

Creates a new backup run on demand.

INSERT INTO google.sqladmin.backup_runs (
data__startTime,
data__endTime,
data__type,
data__description,
data__location,
data__timeZone,
data__selfLink,
data__diskEncryptionStatus,
data__backupKind,
data__instance,
data__id,
data__diskEncryptionConfiguration,
data__status,
data__kind,
data__windowStartTime,
data__enqueuedTime,
data__error,
project,
instance
)
SELECT 
'{{ startTime }}',
'{{ endTime }}',
'{{ type }}',
'{{ description }}',
'{{ location }}',
'{{ timeZone }}',
'{{ selfLink }}',
'{{ diskEncryptionStatus }}',
'{{ backupKind }}',
'{{ instance }}',
'{{ id }}',
'{{ diskEncryptionConfiguration }}',
'{{ status }}',
'{{ kind }}',
'{{ windowStartTime }}',
'{{ enqueuedTime }}',
'{{ error }}',
'{{ project }}',
'{{ instance }}'
RETURNING
name,
acquireSsrsLeaseContext,
apiWarning,
backupContext,
endTime,
error,
exportContext,
importContext,
insertTime,
kind,
operationType,
preCheckMajorVersionUpgradeContext,
selfLink,
startTime,
status,
subOperationType,
targetId,
targetLink,
targetProject,
user
;

DELETE examples​

Deletes the backup taken by a backup run.

DELETE FROM google.sqladmin.backup_runs
WHERE project = '{{ project }}' --required
AND instance = '{{ instance }}' --required
AND id = '{{ id }}' --required
;