REST Resource: projects.locations.backupCollections.backups

Recurso: backup

Backup de um cluster.

Representação JSON
{
  "name": string,
  "createTime": string,
  "cluster": string,
  "clusterUid": string,
  "totalSizeBytes": string,
  "expireTime": string,
  "engineVersion": string,
  "backupFiles": [
    {
      object (BackupFile)
    }
  ],
  "nodeType": enum (NodeType),
  "replicaCount": integer,
  "shardCount": integer,
  "backupType": enum (BackupType),
  "state": enum (State),
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "uid": string
}
Campos
name

string

Identificador. Caminho completo do recurso do backup. A última parte do nome é o ID do backup com o seguinte formato: [YYYYMMDDHHMMSS]_[UID do cluster abreviado] OU especificado pelo cliente durante o backup do cluster. Exemplo: 20240515123000_1234

createTime

string (Timestamp format)

Apenas saída. A hora em que o backup foi criado.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

cluster

string

Apenas saída. Caminho do recurso de cluster deste backup.

clusterUid

string

Apenas saída. UID do cluster deste backup.

totalSizeBytes

string (int64 format)

Apenas saída. Tamanho total do backup em bytes.

expireTime

string (Timestamp format)

Apenas saída. O horário em que o backup vai expirar.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

engineVersion

string

Apenas saída. redis-7.2, valkey-7.5

backupFiles[]

object (BackupFile)

Apenas saída. Lista de arquivos de backup do backup.

nodeType

enum (NodeType)

Apenas saída. Tipo de nó do cluster.

replicaCount

integer

Apenas saída. Número de réplicas do cluster.

shardCount

integer

Apenas saída. Número de fragmentos do cluster.

backupType

enum (BackupType)

Apenas saída. Tipo do backup.

state

enum (State)

Apenas saída. Estado do backup.

encryptionInfo

object (EncryptionInfo)

Apenas saída. Informações de criptografia do backup.

uid

string

Apenas saída. Identificador exclusivo atribuído pelo sistema ao backup.

BackupFile

O backup é composto de vários arquivos.

Representação JSON
{
  "fileName": string,
  "sizeBytes": string,
  "createTime": string
}
Campos
fileName

string

Saída apenas. Por exemplo: .rdb

sizeBytes

string (int64 format)

Apenas saída. Tamanho do arquivo de backup em bytes.

createTime

string (Timestamp format)

Apenas saída. O horário em que o arquivo de backup foi criado.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

BackupType

Tipo do backup.

Tipos enumerados
BACKUP_TYPE_UNSPECIFIED O valor padrão, não definido.
ON_DEMAND Backup sob demanda.
AUTOMATED Backup automático.

Estado

Estado do backup.

Tipos enumerados
STATE_UNSPECIFIED O valor padrão, não definido.
CREATING O backup está sendo criado.
ACTIVE O backup está ativo e pode ser usado.
DELETING O backup está sendo excluído.
SUSPENDED O backup está suspenso por motivos como exclusão de projeto, encerramento de conta de faturamento etc.

Métodos

delete

Exclui um backup específico.

export

Exporta um backup específico para um URI de destino do Cloud Storage do cliente.

get

Recebe os detalhes de um backup específico.

list

Lista todos os backups de uma coleção de backups.