Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1375137252.2 KB
Backups

Updates the retention period and description of the backup. You can use this API to update final backups only.

patch/v1/{+name}

Path parameters

namestring required

Output only. The resource name of the backup. Format: projects/{project}/backups/{backup}.

Query parameters

updateMaskstring

The list of fields that you can update. You can update only the description and retention period of the final backup.

Request body

type'SQL_BACKUP_TYPE_UNSPECIFIED' | 'AUTOMATED' | 'ON_DEMAND' | 'FINAL'

Output only. The type of this backup. The type can be "AUTOMATED", "ON_DEMAND" or “FINAL”.

descriptionstring

The description of this backup.

ttlDaysstring int64

Input only. The time-to-live (TTL) interval for this resource (in days). For example: ttlDays:7, means 7 days from the current time. The expiration time can't exceed 365 days from the time that the backup is created.

selfLinkstring

Output only. The URI of this resource.

instancestring

The name of the source database instance.

satisfiesPzsboolean

Output only. This status indicates whether the backup satisfies PZS. The status is reserved for future use.

instanceDeletionTimestring google-datetime

Optional. Output only. Timestamp in UTC of when the instance associated with this backup is deleted.

maxChargeableBytesstring int64

Output only. The maximum chargeable bytes for the backup.

locationstring

The storage location of the backups. The location can be multi-regional.

databaseVersion'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'

Output only. The database version of the instance of at the time this backup was made.

namestring

Output only. The resource name of the backup. Format: projects/{project}/backups/{backup}.

kmsKeyVersionstring

Output only. This output contains the encryption status for a backup and the version of the KMS key that's used to encrypt the Cloud SQL instance.

kindstring

Output only. This is always sql#backup.

timeZonestring

Output only. This output contains a backup time zone. If a Cloud SQL for SQL Server instance has a different time zone from the backup's time zone, then the restore to the instance doesn't happen.

satisfiesPziboolean

Output only. This status indicates whether the backup satisfies PZI. The status is reserved for future use.

backupKind'SQL_BACKUP_KIND_UNSPECIFIED' | 'SNAPSHOT' | 'PHYSICAL'

Output only. Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.

expiryTimestring google-datetime

Backup expiration time. A UTC timestamp of when this backup expired.

kmsKeystring

Output only. This output contains the encryption configuration for a backup and the resource name of the KMS key for disk encryption.

state'SQL_BACKUP_STATE_UNSPECIFIED' | 'ENQUEUED' | 'RUNNING' | 'FAILED' | 'SUCCESSFUL' | 'DELETING' | 'DELETION_FAILED'

Output only. The status of this backup.

backupRunstring

Output only. The mapping to backup run resource used for IAM validations.

Response

Successful response