Sign in

v1

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

Starts creating a new Cloud Bigtable Backup. The returned backup long-running operation 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.

post/v2/{+parent}/backups

Path parameters

parentstring required

Required. This must be one of the clusters in the instance in which this table is located. The backup will be stored in this cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

Query parameters

backupIdstring

Required. The id of the backup to be created. The backup_id along with the parent parent are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}. This string must be between 1 and 50 characters in length and match the regex _a-zA-Z0-9*.

Request body

sourceTablestring

Required. Immutable. Name of the table 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}/tables/{source_table}.

expireTimestring google-datetime

Required. The expiration time of the backup. When creating a backup or updating its expire_time, the value must be greater than the backup creation time by: - At least 6 hours - At most 90 days Once the expire_time has passed, Cloud Bigtable will delete the backup.

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

Output only. The current state of the backup.

hotToStandardTimestring google-datetime

The time at which the hot backup will be converted to a standard backup. Once the hot_to_standard_time has passed, Cloud Bigtable will convert the hot backup to a standard backup. This value must be greater than the backup creation time by: - At least 24 hours This field only applies for hot backups. When creating or updating a standard backup, attempting to set this field will fail the request.

namestring

A globally unique identifier for the backup which cannot be changed. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a-zA-Z0-9* The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form projects/{project}/instances/{instance}/clusters/{cluster}.

startTimestring google-datetime

Output only. start_time is the time that the backup was started (i.e. approximately the time the CreateBackup request is received). The row data in this backup will be no older than this timestamp.

backupType'BACKUP_TYPE_UNSPECIFIED' | 'STANDARD' | 'HOT'

Indicates the backup type of the backup.

endTimestring google-datetime

Output only. end_time is the time that the backup was finished. The row data in the backup will be no newer than this timestamp.

sizeBytesstring int64

Output only. Size of the backup in bytes.

sourceBackupstring

Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//clusters//backups/

Response

Successful response