REST Resource: projects.locations.backupPlans

{
  "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
}

string

Apenas saída. O nome completo do recurso BackupPlan. Formato: projects/*/locations/*/backupPlans/*

string

Apenas saída. Identificador exclusivo global gerado pelo servidor no formato UUID.

string (Timestamp format)

Apenas saída. O carimbo de data/hora em que este recurso do BackupPlan 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".

string (Timestamp format)

Apenas saída. O carimbo de data/hora em que este recurso do BackupPlan 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".

string

O usuário especificou uma string descritiva para esse BackupPlan.

string

Obrigatório. Imutável. O cluster de origem em que os backups serão criados por meio deste BackupPlan. Formatos válidos:

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

object (RetentionPolicy)

A RetentionPolicy rege o ciclo de vida dos backups criados neste plano.

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

object (Schedule)

Define uma programação para a criação automática de backups pelo BackupPlan.

string

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

boolean

Essa sinalização indica se o BackupPlan foi desativado. Definir esse campo como "True" bloqueia o BackupPlan de modo que nenhuma outra atualização seja permitida (exceto exclusões), incluindo o próprio campo desativado. Isso também impede que novos backups sejam criados por meio desse BackupPlan (incluindo backups programados).

Padrão: False.

object (BackupConfig)

Define a configuração dos backups criados por esse BackupPlan.

integer

Apenas saída. O número de pods do Kubernetes salvos em backup no último backup bem-sucedido criado por esse BackupPlan.

enum (State)

Apenas saída. Estado do BackupPlan. Este campo Estado reflete os vários estágios em que um BackupPlan pode estar durante a operação de criação. Ele será definido como "DESATIVADO" se o BackupPlan for desativado em uma atualização

string

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

{
  "backupDeleteLockDays": integer,
  "backupRetainDays": integer,
  "locked": boolean
}

integer

Idade mínima para backups criados por este BackupPlan (em dias). O campo PRECISA ser um valor inteiro entre 0 e 90 (inclusive). Um Backup criado neste BackupPlan NÃO será excluído até que atinja o (createTime + backupDeleteLockDays) do backup. A atualização deste campo de um BackupPlan NÃO afeta os backups existentes sob ele. Os backups criados APÓS uma atualização bem-sucedida herdarão o novo valor.

Padrão: 0 (sem bloqueio de exclusão)

integer

A idade máxima padrão de um backup criado por esse BackupPlan. O campo PRECISA ser um valor inteiro maior ou igual a 0 e menor ou igual a 365. Se especificado, um Backup criado neste BackupPlan será excluído automaticamente quando a idade dele atingir (createTime + backupRetainDays). Se não for especificado, os Backups criados neste BackupPlan NÃO estarão sujeitos à exclusão automática. A atualização deste campo NÃO afeta os backups existentes nele. Os backups criados DEPOIS de uma atualização bem-sucedida captarão automaticamente o novo valor. OBSERVAÇÃO: backupRetainDays precisa ser >= backupDeleteLockDays. Se cronSchedule estiver definido, o valor precisará ser <= 360 * o intervalo de criação.

Padrão: 0 (sem exclusão automática)

boolean

Essa sinalização indica se a política de retenção deste BackupPlan está bloqueada. Se definida como verdadeira, nenhuma outra atualização será permitida nesta política, incluindo o próprio campo locked.

Padrão: False.

{
  "cronSchedule": string,
  "paused": boolean
}

string

Uma string cron padrão que define uma programação de repetição para a criação de backups por meio desse BackupPlan. Isso é mutuamente exclusivo com o campo rpoConfig, já que no máximo uma programação pode ser definida para um BackupPlan. Se isso for definido, backupRetainDays também precisará ser definido.

Padrão (vazio): nenhuma criação de backup automática ocorrerá.

boolean

Essa sinalização indica se a criação automática de backups está pausada para esse BackupPlan.

Padrão: False.

{
  "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.
}

boolean

Essa sinalização especifica se será necessário fazer backup dos dados de volume quando os PVCs forem incluídos no escopo de um backup.

Padrão: False.

boolean

Essa sinalização especifica se os recursos de secret do Kubernetes devem ser incluídos quando se enquadrarem no escopo dos backups.

Padrão: False.

object (EncryptionKey)

Isso define uma chave de criptografia gerenciada pelo cliente que será usada para criptografar a parte "config" (recursos do Kubernetes) dos backups criados com esse plano.

Padrão (vazio): os artefatos do backup de configuração não serão criptografados.

boolean

Se "True", inclua todos os recursos com namespace.

object (Namespaces)

Se definido, inclua apenas os recursos nos namespaces listados.

object (NamespacedNames)

Se definido, inclua apenas os recursos referenciados pelos ProtectedApplications listados.