v1

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

Creates a Backup for the given BackupPlan.

post/v1/{+parent}/backups

Path parameters

parentstring required

Required. The BackupPlan within which to create the Backup. Format: projects/*/locations/*/backupPlans/*

Query parameters

backupIdstring

Optional. The client-provided short name for the Backup resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of Backups in this BackupPlan

Request body

allNamespacesboolean

Output only. If True, all namespaces were included in the Backup.

createTimestring google-datetime

Output only. The timestamp when this Backup resource was created.

manualboolean

Output only. This flag indicates whether this Backup resource was created manually by a user or via a schedule in the BackupPlan. A value of True means that the Backup was created manually.

state'STATE_UNSPECIFIED' | 'CREATING' | 'IN_PROGRESS' | 'SUCCEEDED' | 'FAILED' | 'DELETING'

Output only. Current state of the Backup

resourceCountinteger

Output only. The total number of Kubernetes resources included in the Backup.

retainDaysinteger

Optional. The age (in days) after which this Backup will be automatically deleted. Must be an integer value >= 0: - If 0, no automatic deletion will occur for this Backup. - If not 0, this must be >= delete_lock_days and <= 365. Once a Backup is created, this value may only be increased. Defaults to the parent BackupPlan's backup_retain_days value.

uidstring

Output only. Server generated global unique identifier of UUID4

sizeBytesstring int64

Output only. The total size of the Backup in bytes = config backup size + sum(volume backup sizes)

namespaceCountinteger

Output only. The total number of user managed namespaces contained in the Backup.

retainExpireTimestring google-datetime

Output only. The time at which this Backup will be automatically deleted (calculated from create_time + retain_days).

deleteLockDaysinteger

Optional. Minimum age for this Backup (in days). If this field is set to a non-zero value, the Backup will be "locked" against deletion (either manual or automatic deletion) for the number of days provided (measured from the creation time of the Backup). MUST be an integer value between 0-90 (inclusive). Defaults to parent BackupPlan's backup_delete_lock_days setting and may only be increased (either at creation time or in a subsequent update).

namestring

Output only. Identifier. The fully qualified name of the Backup. projects/*/locations/*/backupPlans/*/backups/*

containsVolumeDataboolean

Output only. Whether or not the Backup contains volume data. Controlled by the parent BackupPlan's include_volume_data value.

permissiveModeboolean

Output only. If false, Backup will fail when Backup for GKE detects Kubernetes configuration that is non-standard or requires additional setup to restore. Inherited from the parent BackupPlan's permissive_mode value.

stateReasonstring

Output only. Human-readable description of why the backup is in the current state. This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent.

podCountinteger

Output only. The total number of Kubernetes Pods contained in the Backup.

updateTimestring google-datetime

Output only. The timestamp when this Backup resource was last updated.

satisfiesPziboolean

Output only. [Output Only] Reserved for future use.

labelsobject

Optional. A set of custom labels supplied by user.

containsSecretsboolean

Output only. Whether or not the Backup contains Kubernetes Secrets. Controlled by the parent BackupPlan's include_secrets value.

etagstring

Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform backup updates in order to avoid race conditions: An etag is returned in the response to GetBackup, and systems are expected to put that etag in the request to UpdateBackup or DeleteBackup to ensure that their change will be applied to the same version of the resource.

volumeCountinteger

Output only. The total number of volume backups contained in the Backup.

satisfiesPzsboolean

Output only. [Output Only] Reserved for future use.

completeTimestring google-datetime

Output only. Completion time of the Backup

deleteLockExpireTimestring google-datetime

Output only. The time at which an existing delete lock will expire for this backup (calculated from create_time + delete_lock_days).

configBackupSizeBytesstring int64

Output only. The size of the config backup in bytes.

descriptionstring

Optional. User specified descriptive string for this Backup.

Response

Successful response