REST Resource: projects.locations.backupPlans.backups

Risorsa: backup

Rappresenta una richiesta di esecuzione di un'acquisizione singola point-in-time di una parte dello stato di un cluster GKE, del record dell'operazione di backup stessa e di un ancoraggio per gli artefatti sottostanti che compongono il backup (il backup della configurazione e VolumeBackups). ID successivo: 28

Rappresentazione JSON
{
  "name": string,
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "manual": boolean,
  "labels": {
    string: string,
    ...
  },
  "deleteLockDays": integer,
  "deleteLockExpireTime": string,
  "retainDays": integer,
  "retainExpireTime": string,
  "encryptionKey": {
    object (EncryptionKey)
  },
  "containsVolumeData": boolean,
  "containsSecrets": boolean,
  "clusterMetadata": {
    object (ClusterMetadata)
  },
  "state": enum (State),
  "stateReason": string,
  "completeTime": string,
  "resourceCount": integer,
  "volumeCount": integer,
  "sizeBytes": string,
  "etag": string,
  "description": string,
  "podCount": integer,
  "configBackupSizeBytes": string,

  // Union field backup_scope can be only one of the following:
  "allNamespaces": boolean,
  "selectedNamespaces": {
    object (Namespaces)
  },
  "selectedApplications": {
    object (NamespacedNames)
  }
  // End of list of possible types for union field backup_scope.
}
Campi
name

string

Solo output. Il nome completo del backup. projects/*/locations/*/backupPlans/*/backups/*

uid

string

Solo output. Identificatore univoco globale generato dal server di UUID4

createTime

string (Timestamp format)

Solo output. Il timestamp di creazione della risorsa di backup.

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Solo output. Il timestamp dell'ultimo aggiornamento di questa risorsa di backup.

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

manual

boolean

Solo output. Questo flag indica se la risorsa di backup è stata creata manualmente da un utente o tramite una pianificazione in BackupPlan. Il valore True indica che il backup è stato creato manualmente.

labels

map (key: string, value: string)

Un insieme di etichette personalizzate fornite dall'utente.

Un oggetto contenente un elenco di "key": value coppie. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

deleteLockDays

integer

Età minima per questo backup (in giorni). Se questo campo viene impostato su un valore diverso da zero, il backup verrà "bloccato" contro l'eliminazione (manuale o automatica) per il numero di giorni fornito (misurato dal momento della creazione del backup). DEVE essere un valore intero compreso tra 0 e 90 (incluso).

Il valore predefinito è l'impostazione backupDeleteLockDays dell'elemento BackupPlan principale e può essere aumentato solo (al momento della creazione o in un aggiornamento successivo).

deleteLockExpireTime

string (Timestamp format)

Solo output. L'ora in cui scade un blocco di eliminazione esistente per questo backup (calcolato da createTime + deleteLockDays).

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

retainDays

integer

L'età (in giorni) dopo la quale il backup verrà eliminato automaticamente. Deve essere un valore intero >= 0:

  • Se il valore è 0, non verrà eseguita alcuna eliminazione automatica per questo backup.
  • Se è diverso da 0, deve essere >= deleteLockDays e <= 365.

Una volta creato un backup, questo valore può solo essere aumentato.

Il valore predefinito è backupRetainDays del BackupPlan principale.

retainExpireTime

string (Timestamp format)

Solo output. L'ora in cui il backup verrà eliminato automaticamente (calcolato da createTime + retainDays).

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

encryptionKey

object (EncryptionKey)

Solo output. La chiave di crittografia gestita dal cliente utilizzata per criptare gli artefatti del backup. Ereditato dal valore encryptionKey dell'elemento BackupPlan principale.

containsVolumeData

boolean

Solo output. Indica se il backup contiene o meno i dati di volume. Controllato dal valore includeVolumeData dell'elemento BackupPlan principale.

containsSecrets

boolean

Solo output. Indica se il backup contiene o meno secret di Kubernetes. Controllato dal valore includeSecrets dell'elemento BackupPlan principale.

clusterMetadata

object (ClusterMetadata)

Solo output. Informazioni sul cluster GKE da cui è stato creato il backup.

state

enum (State)

Solo output. Stato attuale del backup

stateReason

string

Solo output. Descrizione leggibile del motivo per cui il backup si trova nell'attuale state.

completeTime

string (Timestamp format)

Solo output. Ora di completamento del backup

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

resourceCount

integer

Solo output. Il numero totale di risorse Kubernetes incluse nel backup.

volumeCount

integer

Solo output. Il numero totale di backup del volume contenuti nel backup.

sizeBytes

string (int64 format)

Solo output. La dimensione totale del backup in byte = dimensione del backup della configurazione + somma(dimensioni del backup del volume)

etag

string

Solo output. etag viene utilizzato per il controllo ottimistico della contemporaneità per evitare che aggiornamenti simultanei di un backup si sovrascrivano a vicenda. Si consiglia vivamente ai sistemi di utilizzare etag nel ciclo di lettura, modifica e scrittura per eseguire aggiornamenti di backup al fine di evitare race condizioni: nella risposta a backups.get viene restituito un etag e i sistemi dovrebbero inserire questo etag nella richiesta a backups.patch o backups.delete per garantire che la modifica venga applicata alla stessa versione della risorsa.

description

string

Stringa descrittiva specificata dall'utente per questo backup.

podCount

integer

Solo output. Il numero totale di pod Kubernetes contenuti nel backup.

configBackupSizeBytes

string (int64 format)

Solo output. Le dimensioni del backup della configurazione in byte.

Campo di unione backup_scope. Definisce l'"ambito" del backup, ovvero quali risorse con spazio dei nomi nel cluster sono state incluse nel backup. Ereditato dal valore [backup_scope][google.cloud.gkebackup.v1.BackupPlan.BackupConfig.backup_scope] dell'elemento principale BackupPlan. backup_scope può essere solo uno dei seguenti:
allNamespaces

boolean

Solo output. Se True, tutti gli spazi dei nomi sono stati inclusi nel backup.

selectedNamespaces

object (Namespaces)

Solo output. Se impostato, l'elenco degli spazi dei nomi inclusi nel backup.

selectedApplications

object (NamespacedNames)

Solo output. Se impostato, l'elenco delle applicazioni protette le cui risorse sono state incluse nel backup.

ClusterMetadata

Informazioni sul cluster GKE da cui è stato creato il backup.

Rappresentazione JSON
{
  "cluster": string,
  "k8sVersion": string,
  "backupCrdVersions": {
    string: string,
    ...
  },

  // Union field platform_version can be only one of the following:
  "gkeVersion": string,
  "anthosVersion": string
  // End of list of possible types for union field platform_version.
}
Campi
cluster

string

Il cluster di origine da cui è stato creato il backup. Formati validi:

  • projects/*/locations/*/clusters/*
  • projects/*/zones/*/clusters/*

Viene ereditato dal campo cluster del BackupPlan principale.

k8sVersion

string

La versione del server Kubernetes del cluster di origine.

backupCrdVersions

map (key: string, value: string)

Un elenco delle versioni CRD di Backup per GKE trovate nel cluster.

Un oggetto contenente un elenco di "key": value coppie. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Campo di unione platform_version. La versione specifica della piattaforma platform_version può essere solo una delle seguenti:
gkeVersion

string

Versione GKE

anthosVersion

string

Versione Anthos

Stato

Stato

Enum
STATE_UNSPECIFIED La risorsa di backup è in fase di creazione.
CREATING La risorsa Backup è stata creata e la risorsa Kubernetes BackupJob associata è stata inserita nel cluster di origine.
IN_PROGRESS L'agente gkebackup nel cluster ha iniziato a eseguire l'operazione di backup.
SUCCEEDED L'operazione di backup è stata completata.
FAILED L'operazione di backup non è riuscita.
DELETING Questa risorsa di backup (e gli artefatti associati) è in fase di eliminazione.

Metodi

create

Crea un backup per il BackupPlan specificato.

delete

Elimina un backup esistente.

get

Recupera i dettagli di un singolo backup.

getIamPolicy

Ottieni il criterio di controllo dell'accesso per una risorsa.

list

Elenca i backup per un determinato BackupPlan.

patch

Aggiorna un backup.

setIamPolicy

Imposta il criterio di controllo dell'accesso sulla risorsa specificata.

testIamPermissions

Restituisce le autorizzazioni di cui un chiamante dispone per la risorsa specificata.