Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1350180291.1 KB
projects

Starts creating a new Cloud Spanner Backup. The returned backup long-running operation will have a name of the format projects//instances//backups//operations/ and can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.

post/v1/{+parent}/backups

Path parameters

parentstring required

Required. The name of the instance in which the backup is created. This must be the same instance that contains the database the backup is created from. The backup will be stored in the locations specified in the instance configuration of this instance. Values are of the form projects/{project}/instances/{instance}.

Query parameters

backupIdstring

Required. The id of the backup to be created. The backup_id appended to parent forms the full backup name of the form projects/{project}/instances/{instance}/backups/{backup_id}.

encryptionConfig.encryptionType'ENCRYPTION_TYPE_UNSPECIFIED' | 'USE_DATABASE_ENCRYPTION' | 'GOOGLE_DEFAULT_ENCRYPTION' | 'CUSTOMER_MANAGED_ENCRYPTION'

Required. The encryption type of the backup.

encryptionConfig.kmsKeyNamestring

Optional. This field is maintained for backwards compatibility. For new callers, we recommend using kms_key_names to specify the KMS key. Only use kms_key_name if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in us-central1 or nam3, then the database instance must also be in us-central1 or nam3. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encryption_type is CUSTOMER_MANAGED_ENCRYPTION. Values are of the form projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{kms_key_name}.

encryptionConfig.kmsKeyNamesstring[]

Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{kms_key_name}. The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type GOOGLE_MANAGED, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type USER_MANAGED, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for USER_MANAGED type instance configurations.

Request body

databasestring

Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form projects/{project}/instances/{instance}/databases/{database}.

versionTimestring google-datetime

The backup will contain an externally consistent copy of the database at the timestamp specified by version_time. If version_time is not specified, the system will set version_time to the create_time of the backup.

expireTimestring google-datetime

Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the expire_time has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.

namestring

Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form projects/{project}/instances/{instance}/backups/a-z*[a-z0-9] The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form projects/{project}/instances/{instance}.

createTimestring google-datetime

Output only. The time the CreateBackup request is received. If the request does not specify version_time, the version_time of the backup will be equivalent to the create_time.

sizeBytesstring int64

Output only. Size of the backup in bytes. For a backup in an incremental backup chain, this is the sum of the exclusive_size_bytes of itself and all older backups in the chain.

freeableSizeBytesstring int64

Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired.

exclusiveSizeBytesstring int64

Output only. For a backup in an incremental backup chain, this is the storage space needed to keep the data that has changed since the previous backup. For all other backups, this is always the size of the backup. This value may change if backups on the same chain get deleted or expired. This field can be used to calculate the total storage space used by a set of backups. For example, the total space used by all backups of a database can be computed by summing up this field.

state'STATE_UNSPECIFIED' | 'CREATING' | 'READY'

Output only. The current state of the backup.

referencingDatabasesstring[]

Output only. The names of the restored databases that reference the backup. The database names are of the form projects/{project}/instances/{instance}/databases/{database}. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the READY state, the reference to the backup is removed.

databaseDialect'DATABASE_DIALECT_UNSPECIFIED' | 'GOOGLE_STANDARD_SQL' | 'POSTGRESQL'

Output only. The database dialect information for the backup.

referencingBackupsstring[]

Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form projects/{project}/instances/{instance}/backups/{backup}. Referencing backups may exist in different instances. The existence of any referencing backup prevents the backup from being deleted. When the copy operation is done (either successfully completed or cancelled or the destination backup is deleted), the reference to the backup is removed.

maxExpireTimestring google-datetime

Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than Backup.max_expire_time.

backupSchedulesstring[]

Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups. To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup.

incrementalBackupChainIdstring

Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup version_time.

oldestVersionTimestring google-datetime

Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system.

minimumRestorableEdition'EDITION_UNSPECIFIED' | 'STANDARD' | 'ENTERPRISE' | 'ENTERPRISE_PLUS'

Output only. The minimum edition required to successfully restore the backup. Populated only if the edition is Enterprise or Enterprise Plus.

Response

Successful response