REST Resource: projects.locations.backupPlans

Risorsa: BackupPlan

Definisce la configurazione e la pianificazione per una "riga" di backup.

Rappresentazione JSON 
{
  "name": string,
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "description": string,
  "cluster": string,
  "retentionPolicy": {
    object (RetentionPolicy)
  },
  "labels": {
    string: string,
    ...
  },
  "backupSchedule": {
    object (Schedule)
  },
  "etag": string,
  "deactivated": boolean,
  "backupConfig": {
    object (BackupConfig)
  },
  "protectedPodCount": integer,
  "state": enum (State),
  "stateReason": string
}
Campi
name

string

Solo output. Il nome completo della risorsa BackupPlan. Formato: projects/*/locations/*/backupPlans/*
uid

string

Solo output. Identificatore univoco globale generato dal server nel formato UUID.
createTime

string (Timestamp format)

Solo output. Il timestamp di creazione della risorsa BackupPlan.

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 BackupPlan.

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".
description

string

Stringa descrittiva specificata dall'utente per questo BackupPlan.
cluster

string

Obbligatorio. Immutabile. Il cluster di origine da cui verranno creati i backup tramite questo BackupPlan. Formati validi:

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

object (RetentionPolicy)

FidelizzazionePolicy regola il ciclo di vita dei backup creati in questo piano.
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" }.
backupSchedule

object (Schedule)

Definisce una pianificazione per la creazione automatica dei backup tramite questo BackupPlan.
etag

string

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

boolean

Questo flag indica se questo BackupPlan è stato disattivato. Se questo campo viene impostato su True, BackupPlan viene bloccato in modo che non siano consentiti ulteriori aggiornamenti (tranne le eliminazioni), compreso il campo disattivato. Impedisce inoltre la creazione di nuovi backup tramite questo BackupPlan (inclusi i backup pianificati).

Valore predefinito: False
backupConfig

object (BackupConfig)

Definisce la configurazione dei backup creati tramite questo BackupPlan.
protectedPodCount

integer

Solo output. Il numero di pod Kubernetes di cui è stato eseguito il backup nell'ultimo backup riuscito creato tramite questo BackupPlan.
state

enum (State)

Solo output. Stato di BackupPlan. Questo campo Stato riflette le varie fasi in cui può trovarsi un BackupPlan durante l'operazione di creazione. Verrà impostato su "DISATTIVATO" se BackupPlan viene disattivato durante un aggiornamento
stateReason

string

Solo output. Descrizione leggibile del motivo per cui BackupPlan è nell'attuale state

RetentionPolicy

FidelizzazionePolicy definisce un criterio di conservazione dei backup per un BackupPlan.

Rappresentazione JSON 
{
  "backupDeleteLockDays": integer,
  "backupRetainDays": integer,
  "locked": boolean
}
Campi
backupDeleteLockDays

integer

Età minima per i backup creati tramite questo BackupPlan (in giorni). Questo campo DEVE essere un valore intero compreso tra 0 e 90 (incluso). Un backup creato in questo BackupPlan NON potrà essere eliminato fino a quando non raggiunge il valore di backup (createTime + backupDeleteLockDays). L'aggiornamento di questo campo di un BackupPlan NON influisce sui backup esistenti in questo campo. I backup creati DOPO un aggiornamento riuscito erediteranno il nuovo valore.

Valore predefinito: 0 (nessun blocco di eliminazione)
backupRetainDays

integer

L'età massima predefinita di un backup creato tramite questo BackupPlan. Questo campo DEVE essere un valore intero >= 0 e <= 365. Se specificato, un backup creato in questo BackupPlan verrà eliminato automaticamente dopo che la sua età avrà raggiunto (createTime + backupConservaDays). Se non specificato, i backup creati in questo BackupPlan NON saranno soggetti a eliminazione automatica. L'aggiornamento di questo campo NON influisce sui backup esistenti al suo interno. I backup creati DOPO un aggiornamento riuscito acquisiranno automaticamente il nuovo valore. NOTA: backupRetainDays deve essere >= backupDeleteLockDays. Se cronSchedule è definito, deve essere <= 360 * l'intervallo di creazione.

Valore predefinito: 0 (nessuna eliminazione automatica)
locked

boolean

Questo flag indica se il criterio di conservazione di questo BackupPlan è bloccato. Se il criterio viene impostato su True, non sono consentiti ulteriori aggiornamenti per questo criterio, incluso il campo locked stesso.

Valore predefinito: False

Pianificazione

Definisce i parametri di pianificazione per la creazione automatica di backup tramite questo BackupPlan.

Rappresentazione JSON 
{
  "cronSchedule": string,
  "paused": boolean
}
Campi
cronSchedule

string

Una stringa cron standard che definisce una pianificazione ricorrente per la creazione di backup tramite questo BackupPlan. Si escludono a vicenda con il campo rpoConfig poiché è possibile definire al massimo una pianificazione per un BackupPlan. Se questo criterio viene definito, è necessario definire anche backupRetainDays.

Predefinito (vuoto): non verrà creata alcuna creazione automatica del backup.
paused

boolean

Questo flag indica se la creazione automatica di backup è in pausa per questo BackupPlan.

Valore predefinito: False

BackupConfig

BackupConfig definisce la configurazione dei backup creati tramite questo BackupPlan.

Rappresentazione JSON 
{
  "includeVolumeData": boolean,
  "includeSecrets": boolean,
  "encryptionKey": {
    object (EncryptionKey)
  },

  // 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
includeVolumeData

boolean

Questo flag specifica se è necessario eseguire il backup dei dati di volume quando le PVC sono incluse nell'ambito di un backup.

Valore predefinito: False
includeSecrets

boolean

Questo flag specifica se le risorse Secret di Kubernetes devono essere incluse quando rientrano nell'ambito dei backup.

Valore predefinito: False
encryptionKey

object (EncryptionKey)

Questo comando definisce una chiave di crittografia gestita dal cliente che verrà utilizzata per criptare la parte "config" (le risorse Kubernetes) dei backup creati tramite questo piano.

Valore predefinito (vuoto): gli artefatti di backup della configurazione non verranno criptati.
Campo di unione backup_scope. Questo definisce l'"ambito" del backup, ovvero le risorse con spazio dei nomi nel cluster che verranno incluse in un backup. DEVE essere specificato esattamente uno dei campi di backup_scope. backup_scope può essere solo uno dei seguenti:
allNamespaces

boolean

Se True, sono incluse tutte le risorse con spazio dei nomi
selectedNamespaces

object (Namespaces)

Se impostato, includi solo le risorse negli spazi dei nomi elencati.
selectedApplications

object (NamespacedNames)

Se impostato, includi solo le risorse a cui fanno riferimento le applicazioni ProtectedApplications elencate.

Stato

Stato

Enum
STATE_UNSPECIFIED Primo valore predefinito per le enumerazioni.
CLUSTER_PENDING In attesa che lo stato del cluster sia IN ESECUZIONE.
PROVISIONING BackupPlan è in fase di creazione.
READY Il BackupPlan è stato creato ed è pronto per i backup.
FAILED Creazione di BackupPlan non riuscita.
DEACTIVATED Il BackupPlan è stato disattivato.
DELETING BackupPlan è in fase di eliminazione.

Metodi

create

 Crea un nuovo BackupPlan in una determinata posizione.

delete

 Elimina un BackupPlan esistente.

get

 Recupera i dettagli di un singolo BackupPlan.

getIamPolicy

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

list

 Elenca BackupPlans in una determinata posizione.

patch

 Aggiorna un BackupPlan.

setIamPolicy

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

testIamPermissions

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