REST Resource: projects.locations.backupPlans.backups

Ressource: Backup

Représente une requête visant à effectuer une capture à un moment précis d'une partie de l'état d'un cluster GKE, l'enregistrement de l'opération de sauvegarde elle-même et une ancre pour les artefacts sous-jacents qui composent la sauvegarde (la sauvegarde de configuration et VolumeBackups). ID suivant : 28

Représentation 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.
}
Champs
name

string

Uniquement en sortie. Nom complet de la sauvegarde. projects/*/locations/*/backupPlans/*/backups/*
uid

string

Uniquement en sortie. Identifiant unique global généré par le serveur de l'UUID4
createTime

string (Timestamp format)

Uniquement en sortie. Horodatage lors de la création de cette ressource de sauvegarde.

Horodatage au format RFC3339 UTC "Zulu", avec une précision de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Uniquement en sortie. Horodatage de la dernière mise à jour de cette ressource de sauvegarde.

Horodatage au format RFC3339 UTC "Zulu", avec une précision de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
manual

boolean

Uniquement en sortie. Cette option indique si cette ressource de sauvegarde a été créée manuellement par un utilisateur ou via une programmation dans le BackupPlan. La valeur "True" signifie que la sauvegarde a été créée manuellement.
labels

map (key: string, value: string)

Ensemble d'étiquettes personnalisées fournies par l'utilisateur.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
deleteLockDays

integer

Âge minimal pour cette sauvegarde (en jours). Si ce champ est défini sur une valeur non nulle, la sauvegarde est "verrouillée" contre toute suppression (suppression manuelle ou automatique) pendant le nombre de jours fournis (mesuré à partir de l'heure de création de la sauvegarde). DOIT être un nombre entier compris entre 0 et 90 (inclus).

La valeur par défaut est définie sur le paramètre backupDeleteLockDays du BackupPlan parent et ne peut être augmenté (au moment de la création ou lors d'une mise à jour ultérieure).
deleteLockExpireTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle un verrou de suppression existant expire pour cette sauvegarde (calculée à partir de createTime + deleteLockDays).

Horodatage au format RFC3339 UTC "Zulu", avec une précision de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
retainDays

integer

Âge (en jours) après lequel cette sauvegarde sera automatiquement supprimée. La valeur doit être un nombre entier supérieur ou égal à 0:

  • Si la valeur est 0, aucune suppression automatique ne sera effectuée pour cette sauvegarde.
  • Si la valeur n'est pas égale à 0, la valeur doit être supérieure ou égale à deleteLockDays et <= 365.

Une fois la sauvegarde créée, cette valeur peut uniquement être augmentée.

La valeur par défaut est la valeur backupRetainDays du BackupPlan parent.
retainExpireTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle la sauvegarde sera automatiquement supprimée (calculée à partir de createTime + retainDays).

Horodatage au format RFC3339 UTC "Zulu", avec une précision de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
encryptionKey

object (EncryptionKey)

Uniquement en sortie. Clé de chiffrement gérée par le client qui a été utilisée pour chiffrer les artefacts de la sauvegarde. Hérité de la valeur encryptionKey du BackupPlan parente.
containsVolumeData

boolean

Uniquement en sortie. Indique si la sauvegarde contient des données de volume. Contrôlé par la valeur includeVolumeData du BackupPlan parente.
containsSecrets

boolean

Uniquement en sortie. Indique si la sauvegarde contient ou non des secrets Kubernetes. Contrôlé par la valeur includeSecrets du BackupPlan parente.
clusterMetadata

object (ClusterMetadata)

Uniquement en sortie. Informations sur le cluster GKE à partir duquel cette sauvegarde a été créée.
state

enum (State)

Uniquement en sortie. État actuel de la sauvegarde
stateReason

string

Uniquement en sortie. Description lisible de la raison pour laquelle la sauvegarde se trouve dans le state actuel.
completeTime

string (Timestamp format)

Uniquement en sortie. Heure de fin de la sauvegarde

Horodatage au format RFC3339 UTC "Zulu", avec une précision de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
resourceCount

integer

Uniquement en sortie. Nombre total de ressources Kubernetes incluses dans la sauvegarde.
volumeCount

integer

Uniquement en sortie. Nombre total de sauvegardes de volume contenues dans la sauvegarde.
sizeBytes

string (int64 format)

Uniquement en sortie. Taille totale de la sauvegarde en octets = taille de la sauvegarde de configuration + somme(tailles des sauvegardes de volume)
etag

string

Uniquement en sortie. etag permet d'effectuer un contrôle de simultanéité positive, pour éviter que les mises à jour simultanées d'une sauvegarde ne s'écrasent les unes les autres. Afin d'éviter les situations de concurrence, il est fortement suggéré que les systèmes utilisent etag dans le cycle lecture-modification-écriture pour effectuer des mises à jour de sauvegardes : un etag est renvoyé dans la réponse à backups.get, et les systèmes doivent mettre cet élément dans la requête destinée à backups.patch ou backups.delete de sorte à s'assurer que leur modification sera appliquée à la même version de la stratégie.
description

string

Chaîne descriptive spécifiée par l'utilisateur pour cette sauvegarde.
podCount

integer

Uniquement en sortie. Nombre total de pods Kubernetes contenus dans la sauvegarde.
configBackupSizeBytes

string (int64 format)

Uniquement en sortie. Taille de la sauvegarde de configuration en octets.
Champ d'union backup_scope. Définit le "champ d'application" de la sauvegarde, c'est-à-dire les ressources en espace de noms du cluster qui ont été incluses dans la sauvegarde. Hérité de la valeur [backup_scope][google.cloud.gkebackup.v1.BackupPlan.BackupConfig.backup_scope] du parent BackupPlan. backup_scope ne peut être qu'un des éléments suivants :
allNamespaces

boolean

Uniquement en sortie. Si la valeur est "true", tous les espaces de noms ont été inclus dans la sauvegarde.
selectedNamespaces

object (Namespaces)

Uniquement en sortie. Si défini, liste des espaces de noms inclus dans la sauvegarde.
selectedApplications

object (NamespacedNames)

Uniquement en sortie. Si ce champ est défini, la liste des applications protégées dont les ressources ont été incluses dans la sauvegarde.

ClusterMetadata

Informations sur le cluster GKE à partir duquel cette sauvegarde a été créée.

Représentation 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.
}
Champs
cluster

string

Cluster source à partir duquel cette sauvegarde a été créée. Formats valides:

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

Cette valeur est héritée du champ cluster du BackupPlan parent.
k8sVersion

string

Version du serveur Kubernetes du cluster source.
backupCrdVersions

map (key: string, value: string)

Liste des versions de l'objet CRD Sauvegarde pour GKE trouvées dans le cluster.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Champ d'union platform_version. La version platform_version spécifique à la plate-forme ne peut être que l'un des éléments suivants:
gkeVersion

string

Version de GKE
anthosVersion

string

Version d'Anthos

État

État

Enums
STATE_UNSPECIFIED La ressource de sauvegarde est en cours de création.
CREATING La ressource de sauvegarde a été créée et la ressource Kubernetes BackupJob associée a été injectée dans le cluster source.
IN_PROGRESS L'agent gkebackup du cluster a commencé à exécuter l'opération de sauvegarde.
SUCCEEDED L'opération de sauvegarde a bien été effectuée.
FAILED L'opération de sauvegarde a échoué.
DELETING Cette ressource de sauvegarde (et ses artefacts associés) est en cours de suppression.

Méthodes

create

 Crée une sauvegarde pour le BackupPlan donné.

delete

 Supprime une sauvegarde existante.

get

 Récupère les détails d'une seule sauvegarde.

getIamPolicy

 Récupère la stratégie de contrôle d'accès d'une ressource.

list

 Répertorie les sauvegardes d'un BackupPlan donné.

patch

 Mettre à jour une sauvegarde

setIamPolicy

 Définit la stratégie de contrôle d'accès de la ressource spécifiée.

testIamPermissions

 Renvoie les autorisations qu'un appelant a sur la ressource spécifiée.