REST Resource: projects.locations.backupPlans.backups

Recurso: Copia de seguridad

Representa una solicitud para realizar una captura de un momento determinado de una parte del estado de un clúster de GKE, el registro de la operación de copia de seguridad en sí y un ancla para los artefactos subyacentes que componen la copia de seguridad (la copia de seguridad de la configuración y VolumeBackups). ID siguiente: 28

Representación 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.
}
Campos
name

string

Solo salida. El nombre completamente calificado de la copia de seguridad. projects/*/locations/*/backupPlans/*/backups/*

uid

string

Solo salida. Identificador único global generado por el servidor de UUID4

createTime

string (Timestamp format)

Solo salida. La marca de tiempo de la creación de este recurso de copia de seguridad.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Solo salida. La marca de tiempo de la última actualización de este recurso de copia de seguridad.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

manual

boolean

Solo salida. Esta marca indica si un usuario creó este recurso de copia de seguridad de forma manual o mediante una programación en BackupPlan. Un valor verdadero significa que la copia de seguridad se creó de forma manual.

labels

map (key: string, value: string)

Un conjunto de etiquetas personalizadas proporcionadas por el usuario.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

deleteLockDays

integer

Antigüedad mínima para esta copia de seguridad (en días). Si este campo se configura en un valor distinto de cero, la copia de seguridad se “bloqueará” para que no se pueda borrar (ya sea de forma manual o automática) durante la cantidad de días proporcionados (medido desde el momento de la creación de la copia de seguridad). DEBE ser un número entero entre 0 y 90 (inclusive).

La configuración predeterminada es la configuración backupDeleteLockDays de BackupPlan superior y solo se puede aumentar (en el momento de la creación o en una actualización posterior).

deleteLockExpireTime

string (Timestamp format)

Solo salida. La hora en la que expirará un bloqueo de eliminación existente para esta copia de seguridad (calculada a partir de createTime + deleteLockDays).

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

retainDays

integer

La antigüedad (en días) después de la cual se borrará automáticamente esta copia de seguridad. Debe ser un valor de número entero mayor o igual que 0.

  • Si el valor es 0, no se realizará una eliminación automática para esta copia de seguridad.
  • Si no es 0, debe ser >= deleteLockDays y <= 365.

Una vez que se crea una copia de seguridad, este valor solo se puede aumentar.

El valor predeterminado es el valor backupRetainDays del BackupPlan superior.

retainExpireTime

string (Timestamp format)

Solo salida. La hora en la que se borrará automáticamente esta copia de seguridad (calculada a partir de createTime + retainDays).

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

encryptionKey

object (EncryptionKey)

Solo salida. La clave de encriptación administrada por el cliente que se usó para encriptar los artefactos de la copia de seguridad. Se hereda del valor encryptionKey del nivel superior de BackupPlan.

containsVolumeData

boolean

Solo salida. Indica si la copia de seguridad contiene datos de volumen o no. Se controla mediante el valor includeVolumeData del superior BackupPlan.

containsSecrets

boolean

Solo salida. Indica si la copia de seguridad contiene o no Secrets de Kubernetes. Se controla mediante el valor includeSecrets del superior BackupPlan.

clusterMetadata

object (ClusterMetadata)

Solo salida. Información sobre el clúster de GKE a partir del cual se creó esta copia de seguridad.

state

enum (State)

Solo salida. Estado actual de la copia de seguridad

stateReason

string

Solo salida. Una descripción legible del motivo por el que la copia de seguridad se encuentra en la state actual.

completeTime

string (Timestamp format)

Solo salida. Hora de finalización de la copia de seguridad

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

resourceCount

integer

Solo salida. La cantidad total de recursos de Kubernetes incluidos en la copia de seguridad.

volumeCount

integer

Solo salida. La cantidad total de copias de seguridad de los volúmenes que contiene la copia de seguridad.

sizeBytes

string (int64 format)

Solo salida. El tamaño total de la copia de seguridad en bytes = tamaño de la copia de seguridad de configuración + suma(tamaños de la copia de seguridad del volumen)

etag

string

Solo salida. etag se usa para el control de simultaneidad optimista, como una forma de evitar que las actualizaciones simultáneas de una política se reemplacen entre sí. Se recomienda que los sistemas usen la etag en el ciclo de lectura, modificación y escritura para realizar actualizaciones de copia de seguridad a fin de evitar condiciones de carrera: se muestra una etag en la respuesta a backups.get, y se espera que los sistemas incluyan esa ETag en la solicitud a backups.patch o backups.deletepara garantizar que el cambio se aplique a la misma versión del recurso.

description

string

Es la cadena descriptiva que especificó el usuario para esta copia de seguridad.

podCount

integer

Solo salida. La cantidad total de pods de Kubernetes que se encuentran en la copia de seguridad.

configBackupSizeBytes

string (int64 format)

Solo salida. El tamaño de la copia de seguridad de configuración en bytes.

Campo de unión backup_scope. Define el “alcance” de la copia de seguridad: qué recursos con espacio de nombres en el clúster se incluyeron en la copia de seguridad. Se hereda del valor [backup_scope][google.cloud.gkebackup.v1.BackupPlan.BackupConfig.backup_scope] del nivel superior. backup_scope puede ser solo uno de los siguientes:
allNamespaces

boolean

Solo salida. Si es verdadero, todos los espacios de nombres se incluyeron en la copia de seguridad.

selectedNamespaces

object (Namespaces)

Solo salida. Si se configura, es la lista de espacios de nombres que se incluyeron en la copia de seguridad.

selectedApplications

object (NamespacedNames)

Solo salida. Si se establece, la lista de ProtectedApplications cuyos recursos se incluyeron en la copia de seguridad.

ClusterMetadata

Información sobre el clúster de GKE a partir del cual se creó esta copia de seguridad.

Representación 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.
}
Campos
cluster

string

El clúster de origen desde el que se creó esta copia de seguridad. Formatos válidos:

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

Esto se hereda del campo cluster del nivel superior de BackupPlan.

k8sVersion

string

La versión del servidor de Kubernetes del clúster de origen.

backupCrdVersions

map (key: string, value: string)

Una lista de las versiones de CRD de Copia de seguridad para GKE que se encuentran en el clúster.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Campo de unión platform_version. La versión específica de la plataforma platform_version puede ser solo una de las siguientes opciones:
gkeVersion

string

Versión de GKE

anthosVersion

string

Versión de Anthos

Estado

Estado

Enums
STATE_UNSPECIFIED El recurso de copia de seguridad está en proceso de creación.
CREATING Se creó el recurso de copia de seguridad y se insertó el recurso de Kubernetes de BackupJob asociado en el clúster de origen.
IN_PROGRESS El agente gkebackup del clúster comenzó a ejecutar la operación de copia de seguridad.
SUCCEEDED La operación de copia de seguridad se completó correctamente.
FAILED No se pudo realizar la operación de copia de seguridad.
DELETING Este recurso de copia de seguridad (y sus artefactos asociados) está en proceso de eliminación.

Métodos

create

Crea una copia de seguridad para el BackupPlan determinado.

delete

Borra una copia de seguridad existente.

get

Recupera los detalles de una sola copia de seguridad.

getIamPolicy

Permite obtener la política de control de acceso de un recurso.

list

Enumera las copias de seguridad de un BackupPlan determinado.

patch

Actualizar una copia de seguridad

setIamPolicy

Permite configurar la política de control de acceso en el recurso especificado.

testIamPermissions

Permite mostrar los permisos que tiene un emisor para un recurso especificado.