REST Resource: projects.locations.backupPlans.backups

Recurso: backup

Representa uma solicitação para executar uma única captura pontual de alguma parte do estado de um cluster do GKE, do registro da operação de backup e de uma âncora para os artefatos subjacentes que compõem o backup (o backup de configuração e os VolumeBackups). Próximo ID: 28

Representação 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

Apenas saída. O nome totalmente qualificado do backup. projects/*/locations/*/backupPlans/*/backups/*
uid

string

Apenas saída. Identificador exclusivo global gerado pelo servidor de UUID4
createTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora de quando o recurso de backup foi criado.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora de quando o recurso de backup foi atualizado pela última vez.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
manual

boolean

Apenas saída. Essa flag indica se o recurso de backup foi criado manualmente por um usuário ou por uma programação no BackupPlan. O valor verdadeiro significa que o Backup foi criado manualmente.
labels

map (key: string, value: string)

Um conjunto de rótulos personalizados fornecidos pelo usuário.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
deleteLockDays

integer

Idade mínima para esse backup (em dias). Se esse campo for definido com um valor diferente de zero, o Backup será "bloqueado" contra exclusão (manual ou automática) pelo número de dias fornecidos (medidos a partir do momento de criação do Backup). PRECISA ser um número inteiro entre 0 e 90 (inclusive).

O padrão é a configuração backupDeleteLockDays do BackupPlan pai e só pode ser aumentado no momento da criação ou em uma atualização subsequente.
deleteLockExpireTime

string (Timestamp format)

Apenas saída. O horário em que um bloqueio de exclusão existente expira para esse backup (calculado a partir de createTime + deleteLockDays).

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
retainDays

integer

A idade (em dias) após a qual este Backup será excluído automaticamente. Precisa ser um valor inteiro maior ou igual a 0:

  • Se o valor for 0, não haverá exclusão automática para esse Backup.
  • Se não for 0, precisará ser maior ou igual a deleteLockDays e menor ou igual a 365.

Depois que um backup é criado, esse valor só pode ser aumentado.

O padrão é o valor backupRetainDays do BackupPlan pai.
retainExpireTime

string (Timestamp format)

Apenas saída. A hora em que esse Backup será excluído automaticamente (calculado a partir de createTime + retainDays).

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
encryptionKey

object (EncryptionKey)

Apenas saída. A chave de criptografia gerenciada pelo cliente que foi usada para criptografar os artefatos do backup. Herdada do valor encryptionKey do BackupPlan pai.
containsVolumeData

boolean

Apenas saída. Define se o backup contém ou não dados de volume. Controlado pelo valor includeVolumeData do BackupPlan pai.
containsSecrets

boolean

Apenas saída. Define se o backup contém ou não secrets do Kubernetes. Controlado pelo valor includeSecrets do BackupPlan pai.
clusterMetadata

object (ClusterMetadata)

Apenas saída. Informações sobre o cluster do GKE com base no qual esse backup foi criado.
state

enum (State)

Apenas saída. Estado atual do backup
stateReason

string

Apenas saída. Descrição legível por humanos do motivo pelo qual o backup está no state atual.
completeTime

string (Timestamp format)

Apenas saída. Hora de conclusão do backup

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
resourceCount

integer

Apenas saída. O número total de recursos do Kubernetes incluídos no backup.
volumeCount

integer

Apenas saída. O número total de backups de volume contidos no backup.
sizeBytes

string (int64 format)

Apenas saída. O tamanho total do backup em bytes = tamanho do backup de configuração + soma (tamanhos de backup de volume)
etag

string

Apenas saída. etag é usado para controle de simultaneidade otimista como uma maneira de impedir que atualizações simultâneas de um backup substituam umas às outras. É altamente recomendável que os sistemas usem o etag no ciclo de leitura/modificação/gravação para executar atualizações de backup a fim de evitar disputas: um etag é retornado na resposta a backups.get. Os sistemas precisam colocar essa ETag na solicitação para backups.patch ou backups.delete para garantir que a alteração seja aplicada à mesma versão do recurso.
description

string

String descritiva especificada pelo usuário para esse backup.
podCount

integer

Apenas saída. O número total de pods do Kubernetes contidos no backup.
configBackupSizeBytes

string (int64 format)

Apenas saída. O tamanho do backup da configuração em bytes.
Campo de união backup_scope. Define o "escopo" do backup: quais recursos com namespace no cluster foram incluídos no backup. Herdado do valor [backup_scope][google.cloud.gkebackup.v1.BackupPlan.BackupConfig.backup_scope] do BackupPlan pai. backup_scope pode ser apenas de um dos tipos a seguir:
allNamespaces

boolean

Apenas saída. Se for verdadeiro, todos os namespaces foram incluídos no backup.
selectedNamespaces

object (Namespaces)

Apenas saída. Se definido, a lista de namespaces que foram incluídos no backup.
selectedApplications

object (NamespacedNames)

Apenas saída. Se definido, a lista de ProtectedApplications com os recursos que foram incluídos no backup.

ClusterMetadata

Informações sobre o cluster do GKE com base no qual esse backup foi criado.

Representação 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

O cluster de origem com base no qual esse backup foi criado. Formatos válidos:

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

Isso é herdado do campo cluster do BackupPlan pai.
k8sVersion

string

A versão do servidor do Kubernetes do cluster de origem.
backupCrdVersions

map (key: string, value: string)

Uma lista das versões de CRD do Backup para GKE encontradas no cluster.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Campo de união platform_version. A versão específica da plataforma platform_version só pode ser uma destas:
gkeVersion

string

Versão GKE
anthosVersion

string

Versão Anthos

Estado

Estado

Enums
STATE_UNSPECIFIED O recurso de backup está em processo de criação.
CREATING O recurso de backup foi criado, e o recurso do Kubernetes associado BackupJob foi injetado no cluster de origem.
IN_PROGRESS O agente gkebackup no cluster começou a executar a operação de backup.
SUCCEEDED A operação de backup foi concluída.
FAILED A operação de backup falhou.
DELETING Esse recurso de backup e os artefatos associados estão em processo de exclusão.

Métodos

create

 Cria um backup para o BackupPlan em questão.

delete

 Exclui um backup existente.

get

 Recupera os detalhes de um único backup.

getIamPolicy

 Busca a política de controle de acesso de um recurso.

list

 Lista os backups de um determinado BackupPlan.

patch

 Atualiza um backup.

setIamPolicy

 Define a política de controle de acesso no recurso especificado.

testIamPermissions

 Retorna permissões do autor da chamada no recurso especificado.