REST Resource: projects.locations.clusters

Recurso: Cluster

Uma instância de cluster.

Representação JSON
{
  "name": string,
  "createTime": string,
  "state": enum (State),
  "uid": string,
  "authorizationMode": enum (AuthorizationMode),
  "transitEncryptionMode": enum (TransitEncryptionMode),
  "pscConfigs": [
    {
      object (PscConfig)
    }
  ],
  "discoveryEndpoints": [
    {
      object (DiscoveryEndpoint)
    }
  ],
  "pscConnections": [
    {
      object (PscConnection)
    }
  ],
  "stateInfo": {
    object (StateInfo)
  },
  "nodeType": enum (NodeType),
  "persistenceConfig": {
    object (ClusterPersistenceConfig)
  },
  "redisConfigs": {
    string: string,
    ...
  },
  "zoneDistributionConfig": {
    object (ZoneDistributionConfig)
  },
  "crossClusterReplicationConfig": {
    object (CrossClusterReplicationConfig)
  },
  "pscServiceAttachments": [
    {
      object (PscServiceAttachment)
    }
  ],
  "clusterEndpoints": [
    {
      object (ClusterEndpoint)
    }
  ],
  "automatedBackupConfig": {
    object (AutomatedBackupConfig)
  },
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "availableMaintenanceVersions": [
    string
  ],
  "allowFewerZonesDeployment": boolean,
  "labels": {
    string: string,
    ...
  },
  "aclPolicy": string,
  "aclPolicyInfo": {
    object (AclPolicyInfo)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "gcsSource": {
    object (GcsBackupSource)
  },
  "managedBackupSource": {
    object (ManagedBackupSource)
  }
  // End of mutually exclusive fields.
  "replicaCount": integer,
  "sizeGb": integer,
  "shardCount": integer,
  "preciseSizeGb": number,
  "deletionProtectionEnabled": boolean,
  "maintenancePolicy": {
    object (ClusterMaintenancePolicy)
  },
  "maintenanceSchedule": {
    object (ClusterMaintenanceSchedule)
  },
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean,
  "simulateMaintenanceEvent": boolean,
  "backupCollection": string,
  "kmsKey": string,
  "ondemandMaintenance": boolean,
  "asyncClusterEndpointsDeletionEnabled": boolean,
  "maintenanceVersion": string,
  "effectiveMaintenanceVersion": string,
  "serverCaMode": enum (ServerCaMode),
  "serverCaPool": string,
  "rotateServerCertificate": boolean,
  "aclPolicyInSync": boolean
}
Campos
name

string

Obrigatório. Identificador. Nome exclusivo do recurso neste escopo, incluindo projeto e local usando o formulário: projects/{projectId}/locations/{locationId}/clusters/{clusterId}

createTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora associado à solicitação de criação de cluster.

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

state

enum (State)

Apenas saída. O estado atual do cluster. Pode ser CREATING, READY, UPDATING, DELETING e SUSPENDED

uid

string

Apenas saída. Identificador exclusivo atribuído pelo sistema para o cluster.

authorizationMode

enum (AuthorizationMode)

Opcional. O modo de autorização do cluster do Redis. Se não for fornecido, o recurso de autenticação será desativado para o cluster.

transitEncryptionMode

enum (TransitEncryptionMode)

Opcional. A criptografia em trânsito para o cluster do Redis. Se não for fornecida, a criptografia será desativada para o cluster.

pscConfigs[]

object (PscConfig)

Opcional. Cada PscConfig configura a rede do consumidor em que os IPs serão designados ao cluster para acesso do cliente pela automação do Private Service Connect. No momento, apenas um PscConfig é aceito.

discoveryEndpoints[]

object (DiscoveryEndpoint)

Apenas saída. Endpoints criados em cada rede especificada para que os clientes Redis se conectem ao cluster. No momento, apenas um endpoint de descoberta é aceito.

pscConnections[]

object (PscConnection)

Apenas saída. A lista de conexões do PSC criadas automaticamente pela automação de conectividade do serviço.

stateInfo

object (StateInfo)

Apenas saída. Outras informações sobre o estado atual do cluster.

nodeType

enum (NodeType)

Opcional. O tipo de um nó do Redis no cluster. NodeType determina o tipo de máquina de um nó do Redis.

persistenceConfig

object (ClusterPersistenceConfig)

Opcional. Configuração de persistência (RDB, AOF) para o cluster.

redisConfigs

map (key: string, value: string)

Opcional. Pares de chave-valor de substituições do cliente para configurações mutáveis do Redis

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

zoneDistributionConfig

object (ZoneDistributionConfig)

Opcional. Essa configuração será usada para determinar como o cliente quer que distribuamos os recursos do cluster na região.

crossClusterReplicationConfig

object (CrossClusterReplicationConfig)

Opcional. Configuração de replicação entre clusters.

pscServiceAttachments[]

object (PscServiceAttachment)

Apenas saída. Detalhes do anexo de serviço para configurar conexões do PSC

clusterEndpoints[]

object (ClusterEndpoint)

Opcional. Uma lista de endpoints de cluster.

automatedBackupConfig

object (AutomatedBackupConfig)

Opcional. A configuração de backup automático do cluster.

encryptionInfo

object (EncryptionInfo)

Apenas saída. Informações de criptografia dos dados em repouso do cluster.

availableMaintenanceVersions[]

string

Apenas saída. Esse campo é usado para determinar as versões de manutenção disponíveis para a atualização de autoatendimento.

allowFewerZonesDeployment
(deprecated)

boolean

Opcional. Imutável. Descontinuado, não use.

labels

map (key: string, value: string)

Opcional. Rótulos para representar metadados fornecidos pelo usuário.

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

aclPolicy

string

Opcional. A política de ACL a ser aplicada ao cluster.

aclPolicyInfo

object (AclPolicyInfo)

Apenas saída. Detalhes da política de ACL aplicada.

A origem da importação. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
gcsSource

object (GcsBackupSource)

Opcional. Backups armazenados em buckets do Cloud Storage. Os buckets do Cloud Storage precisam estar na mesma região que os clusters. A permissão de leitura é necessária para importar dos objetos do Cloud Storage fornecidos.

managedBackupSource

object (ManagedBackupSource)

Opcional. Backups gerados e gerenciados pelo serviço do Memorystore.

Fim dos campos mutuamente exclusivos.
replicaCount

integer

Opcional. O número de nós de réplica por fragmento.

sizeGb

integer

Apenas saída. Tamanho da memória do Redis em GB para todo o cluster, arredondado para o próximo número inteiro.

shardCount

integer

Opcional. Número de fragmentos do cluster do Redis.

preciseSizeGb

number

Apenas saída. Valor preciso do tamanho da memória do Redis em GB para todo o cluster.

deletionProtectionEnabled

boolean

Opcional. A operação de exclusão vai falhar quando o valor for definido como "true".

maintenancePolicy

object (ClusterMaintenancePolicy)

Opcional. A ClusterMaintenancePolicy determina quando permitir ou negar atualizações.

maintenanceSchedule

object (ClusterMaintenanceSchedule)

Apenas saída. ClusterMaintenanceSchedule Output only Published maintenance schedule.

satisfiesPzs

boolean

Opcional. Apenas saída. Reservado para uso futuro.

satisfiesPzi

boolean

Opcional. Apenas saída. Reservado para uso futuro.

simulateMaintenanceEvent

boolean

Opcional. Somente entrada. Simule um evento de manutenção.

backupCollection

string

Opcional. Apenas saída. O nome completo do recurso da coleção de backups. Exemplo: projects/{project}/locations/{location}/backupCollections/{collection}

kmsKey

string

Opcional. A chave do KMS usada para criptografar os dados em repouso do cluster.

ondemandMaintenance
(deprecated)

boolean

Opcional. Somente entrada. Manutenção sob demanda do cluster. Esse campo pode ser usado para acionar uma atualização crítica sob demanda no cluster.

asyncClusterEndpointsDeletionEnabled

boolean

Opcional. Se for "true", os endpoints de cluster criados e registrados pelos clientes poderão ser excluídos de forma assíncrona. Ou seja, um endpoint de cluster pode ser cancelado antes que as regras de encaminhamento no endpoint do cluster sejam excluídas.

maintenanceVersion

string

Opcional. Esse campo pode ser usado para acionar a atualização de autoatendimento e indicar a versão de manutenção desejada. A entrada para esse campo pode ser determinada pelo campo "availableMaintenanceVersions".

effectiveMaintenanceVersion

string

Apenas saída. Esse campo representa a versão de manutenção real do cluster.

serverCaMode

enum (ServerCaMode)

Opcional. Modo de AC do servidor para o cluster.

serverCaPool

string

Opcional. Pool de ACs gerenciado pelo cliente para o cluster. Aplicável apenas a BYOCA, ou seja, se serverCaMode for SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA. Formato: "projects/{project}/locations/{region}/caPools/{ca_pool}".

rotateServerCertificate

boolean

Opcional. Somente entrada. Troque os certificados do servidor.

aclPolicyInSync
(deprecated)

boolean

Opcional. Apenas saída. Descontinuado: indica se as regras da ACL aplicadas ao cluster estão sincronizadas.

GcsBackupSource

Backups armazenados em buckets do Cloud Storage. Os buckets do Cloud Storage precisam estar na mesma região que os clusters.

Representação JSON
{
  "uris": [
    string
  ]
}
Campos
uris[]

string

Opcional. URIs dos objetos do Cloud Storage a serem importados. Exemplo: gs://bucket1/object1, gs://bucket2/folder2/object2

ManagedBackupSource

Backups gerados e gerenciados pelo Memorystore.

Representação JSON
{
  "backup": string
}
Campos
backup

string

Opcional. Exemplo: //redis.googleapis.com/projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup}. Uma versão mais curta (sem o prefixo) do nome do backup também é aceita, como projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backupId}. Nesse caso, presume-se que o backup esteja em redis.googleapis.com.

Estado

Representa os diferentes estados de um cluster do Redis.

Tipos enumerados
STATE_UNSPECIFIED Não definido.
CREATING O cluster do Redis está sendo criado.
ACTIVE O cluster do Redis foi criado e está totalmente utilizável.
UPDATING A configuração do cluster do Redis está sendo atualizada.
DELETING O cluster do Redis está sendo excluído.

AuthorizationMode

Modo de autorização disponível de um cluster do Redis.

Tipos enumerados
AUTH_MODE_UNSPECIFIED Não definido.
AUTH_MODE_IAM_AUTH Modo de autorização básica do IAM
AUTH_MODE_DISABLED Modo de autorização desativado
AUTH_MODE_TOKEN_AUTH Modo de autorização baseado em token

TransitEncryptionMode

Modo disponível de criptografia em trânsito.

Tipos enumerados
TRANSIT_ENCRYPTION_MODE_UNSPECIFIED A criptografia em trânsito não foi definida.
TRANSIT_ENCRYPTION_MODE_DISABLED A criptografia em trânsito está desativada.
TRANSIT_ENCRYPTION_MODE_SERVER_AUTHENTICATION Use a criptografia gerenciada pelo servidor para criptografia em trânsito.

PscConfig

Representação JSON
{
  "network": string
}
Campos
network

string

Obrigatório. A rede em que o endereço IP do endpoint de descoberta será reservado, no formato projects/{networkProject}/global/networks/{network_id}.

DiscoveryEndpoint

Endpoints em cada rede para que os clientes do Redis se conectem ao cluster.

Representação JSON
{
  "address": string,
  "port": integer,
  "pscConfig": {
    object (PscConfig)
  }
}
Campos
address

string

Apenas saída. Endereço do endpoint do Redis exposto usado pelos clientes para se conectar ao serviço. O endereço pode ser IP ou nome do host.

port

integer

Apenas saída. O número da porta do ponto de extremidade do Redis exposto.

pscConfig

object (PscConfig)

Apenas saída. Configuração do cliente para onde o endpoint é criado e acessado.

PscConnection

Detalhes dos recursos do consumidor em uma conexão do PSC.

Representação JSON
{
  "pscConnectionId": string,
  "address": string,
  "forwardingRule": string,
  "projectId": string,
  "network": string,
  "serviceAttachment": string,
  "pscConnectionStatus": enum (PscConnectionStatus),
  "connectionType": enum (ConnectionType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "port": integer
  // End of mutually exclusive fields.
}
Campos
pscConnectionId

string

Obrigatório. O ID da conexão PSC da regra de encaminhamento conectada ao anexo de serviço.

address

string

Obrigatório. O IP alocado na rede do consumidor para a regra de encaminhamento do PSC.

forwardingRule

string

Obrigatório. O URI da regra de encaminhamento do lado do consumidor. Exemplo: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}.

projectId

string

Opcional. ID do projeto do consumidor em que a regra de encaminhamento é criada.

network

string

Obrigatório. A rede do consumidor em que o endereço IP reside, no formato projects/{projectId}/global/networks/{network_id}.

serviceAttachment

string

Obrigatório. O anexo de serviço que é o destino da conexão PSC, no formato projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}.

pscConnectionStatus

enum (PscConnectionStatus)

Apenas saída. O status da conexão do PSC. Esse valor é atualizado periodicamente. Para conferir o status mais recente de uma conexão do PSC, siga https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details.

connectionType

enum (ConnectionType)

Apenas saída. Tipo da conexão PSC.

O número da porta do endpoint de descoberta exposto. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
port

integer

Apenas saída. A porta só será definida para o endpoint principal/leitor ou de descoberta.

Fim dos campos mutuamente exclusivos.

PscConnectionStatus

Status da conexão do PSC.

Tipos enumerados
PSC_CONNECTION_STATUS_UNSPECIFIED O status da conexão do PSC não foi especificado.
PSC_CONNECTION_STATUS_ACTIVE A conexão está ativa
PSC_CONNECTION_STATUS_NOT_FOUND Conexão não encontrada

ConnectionType

Tipo de conexão PSC para fins de acesso ao cluster.

Tipos enumerados
CONNECTION_TYPE_UNSPECIFIED O tipo de endpoint do cluster não está definido
CONNECTION_TYPE_DISCOVERY Endpoint do cluster que será usado para a descoberta da topologia do cluster.
CONNECTION_TYPE_PRIMARY Endpoint do cluster que será usado como endpoint principal para acessar o principal.
CONNECTION_TYPE_READER Endpoint do cluster que será usado como endpoint de leitura para acessar réplicas.

StateInfo

Representa informações adicionais sobre o estado do cluster.

Representação JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "updateInfo": {
    object (UpdateInfo)
  }
  // End of mutually exclusive fields.
}
Campos
Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
updateInfo

object (UpdateInfo)

Descreve a atualização em andamento no cluster quando o estado dele é UPDATING.

Fim dos campos mutuamente exclusivos.

UpdateInfo

Representa informações sobre um cluster em atualização.

Representação JSON
{
  "targetShardCount": integer,
  "targetReplicaCount": integer,
  "targetNodeType": enum (NodeType)
}
Campos
targetShardCount

integer

Número de fragmentos de destino para o cluster do Redis

targetReplicaCount

integer

Número desejado de nós de réplica por fragmento.

targetNodeType

enum (NodeType)

Tipo de nó de destino para cluster do Redis.

ClusterPersistenceConfig

Configuração da funcionalidade de persistência.

Representação JSON
{
  "mode": enum (PersistenceMode),
  "rdbConfig": {
    object (RDBConfig)
  },
  "aofConfig": {
    object (AOFConfig)
  }
}
Campos
mode

enum (PersistenceMode)

Opcional. O modo de persistência.

rdbConfig

object (RDBConfig)

Opcional. Configuração do RDB. Esse campo será ignorado se o modo não for RDB.

aofConfig

object (AOFConfig)

Opcional. Configuração de AOF. Esse campo será ignorado se o modo não for AOF.

PersistenceMode

Modos de persistência disponíveis.

Tipos enumerados
PERSISTENCE_MODE_UNSPECIFIED Não definido.
DISABLED A persistência é desativada, e todos os dados de snapshot são excluídos.
RDB A persistência baseada em RDB está ativada.
AOF A persistência baseada em AOF está ativada.

RDBConfig

Configuração da persistência baseada em RDB.

Representação JSON
{
  "rdbSnapshotPeriod": enum (SnapshotPeriod),
  "rdbSnapshotStartTime": string
}
Campos
rdbSnapshotPeriod

enum (SnapshotPeriod)

Opcional. Período entre snapshots do RDB.

rdbSnapshotStartTime

string (Timestamp format)

Opcional. O momento em que o primeiro snapshot foi/será tentado e a que snapshots futuros serão alinhados. Se não for informado, o horário atual será usado.

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

SnapshotPeriod

Períodos de snapshots disponíveis.

Tipos enumerados
SNAPSHOT_PERIOD_UNSPECIFIED Não definido.
ONE_HOUR Uma hora.
SIX_HOURS Seis horas.
TWELVE_HOURS 12 horas.
TWENTY_FOUR_HOURS 24 horas.

AOFConfig

Configuração da persistência baseada em AOF.

Representação JSON
{
  "appendFsync": enum (AppendFsync)
}
Campos
appendFsync

enum (AppendFsync)

Opcional. Configuração de fsync.

AppendFsync

Modos fsync disponíveis.

Tipos enumerados
APPEND_FSYNC_UNSPECIFIED Não definido. Padrão: EVERYSEC
NO Nunca faça fsync. Normalmente, o Linux libera dados a cada 30 segundos com essa configuração, mas isso depende da sintonia exata do kernel.
EVERYSEC fsync a cada segundo. Rápido o suficiente, e você pode perder 1 segundo de dados se houver um desastre
ALWAYS fsync sempre que novos comandos de gravação forem anexados ao AOF. Ela tem a melhor proteção contra perda de dados ao custo da performance

ZoneDistributionConfig

Configuração de distribuição de zona para alocação de recursos de cluster.

Representação JSON
{
  "mode": enum (ZoneDistributionMode),
  "zone": string,
  "zones": [
    string
  ]
}
Campos
mode

enum (ZoneDistributionMode)

Opcional. O modo de distribuição de zonas. O padrão é MULTI_ZONE quando não especificado.

zone

string

Opcional. Quando a distribuição de ZONA ÚNICA é selecionada, o campo de zona é usado para alocar todos os recursos nessa zona. Isso não é aplicável a MULTI_ZONE e seria ignorado para clusters MULTI_ZONE.

zones[]

string

Opcional. Especifique as zonas de um cluster multizonal em que o Redis Cluster aloca recursos. Essa flag não se aplica a clusters de zona única.

ZoneDistributionMode

Define vários modos de distribuição de zona.

Tipos enumerados
ZONE_DISTRIBUTION_MODE_UNSPECIFIED Não definido. Padrão: MULTI_ZONE
MULTI_ZONE Distribua todos os recursos em três zonas escolhidas aleatoriamente na região.
SINGLE_ZONE Distribuir todos os recursos em uma única zona. O campo "zona" precisa ser especificado quando esse modo é selecionado.

CrossClusterReplicationConfig

Configuração de replicação entre clusters.

Representação JSON
{
  "clusterRole": enum (ClusterRole),
  "primaryCluster": {
    object (RemoteCluster)
  },
  "secondaryClusters": [
    {
      object (RemoteCluster)
    }
  ],
  "updateTime": string,
  "membership": {
    object (Membership)
  }
}
Campos
clusterRole

enum (ClusterRole)

Apenas saída. A função do cluster na replicação entre clusters.

primaryCluster

object (RemoteCluster)

Detalhes do cluster principal usado como origem de replicação para este cluster secundário.

Esse campo só é definido para um cluster secundário.

secondaryClusters[]

object (RemoteCluster)

Lista de clusters secundários que estão replicando deste cluster principal.

Esse campo só é definido para um cluster principal.

updateTime

string (Timestamp format)

Apenas saída. A última vez que a configuração de replicação entre clusters foi atualizada.

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

membership

object (Membership)

Apenas saída. Uma visualização somente de saída de todos os clusters membros que participam da replicação entre clusters. Essa visualização é fornecida por todos os clusters membros, independente da função deles(principal ou secundária).

Um cluster principal pode fornecer informações sobre todos os clusters secundários que estão replicando dele. No entanto, um cluster secundário só conhece o cluster principal de que está replicando. No entanto, em cenários em que o cluster principal não está disponível(por exemplo, uma interrupção regional), uma solicitação "clusters.get" pode ser enviada para qualquer outro cluster de membro, e esse campo vai listar todos os clusters de membros que participam da replicação entre clusters.

ClusterRole

A função do cluster na replicação entre clusters.

Tipos enumerados
CLUSTER_ROLE_UNSPECIFIED A função do cluster não está definida. O comportamento é equivalente a NONE.
NONE Este cluster não participa da replicação entre clusters. Ele é um cluster independente e não faz replicação para nem de outros clusters.
PRIMARY Um cluster que permite leituras e gravações. Todos os dados gravados nesse cluster também são replicados para os clusters secundários anexados.
SECONDARY Um cluster que permite apenas leituras e replica dados de um cluster principal.

RemoteCluster

Detalhes do cluster remoto associado a este cluster em uma configuração de replicação entre clusters.

Representação JSON
{
  "cluster": string,
  "uid": string
}
Campos
cluster

string

Apenas saída. O caminho completo do recurso do cluster remoto no formato: projects//locations//clusters/

uid

string

Apenas saída. O identificador exclusivo do cluster remoto.

Associação

Uma visualização somente de saída de todos os clusters membros que participam da replicação entre clusters.

Representação JSON
{
  "primaryCluster": {
    object (RemoteCluster)
  },
  "secondaryClusters": [
    {
      object (RemoteCluster)
    }
  ]
}
Campos
primaryCluster

object (RemoteCluster)

Apenas saída. O cluster principal que atua como origem da replicação para os clusters secundários.

secondaryClusters[]

object (RemoteCluster)

Apenas saída. A lista de clusters secundários que replicam do cluster principal.

ClusterMaintenancePolicy

Política de manutenção por cluster.

Representação JSON
{
  "createTime": string,
  "updateTime": string,
  "weeklyMaintenanceWindow": [
    {
      object (ClusterWeeklyMaintenanceWindow)
    }
  ]
}
Campos
createTime

string (Timestamp format)

Apenas saída. O momento em que a política foi criada, ou seja, a janela de manutenção ou o período de negação foi atribuído.

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

updateTime

string (Timestamp format)

Apenas saída. O momento em que a política foi atualizada, ou seja, a janela de manutenção ou o período de bloqueio foi atualizado.

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

weeklyMaintenanceWindow[]

object (ClusterWeeklyMaintenanceWindow)

Opcional. Janela de manutenção aplicada aos recursos cobertos por esta política. Mínimo de 1. Para a versão atual, o número máximo de weeklyMaintenanceWindow esperado é um.

ClusterWeeklyMaintenanceWindow

Período especificado para operações semanais.

Representação JSON
{
  "day": enum (DayOfWeek),
  "startTime": {
    object (TimeOfDay)
  }
}
Campos
day

enum (DayOfWeek)

Opcional. Permite definir uma programação que é executada em um dia específico da semana.

startTime

object (TimeOfDay)

Opcional. Horário de início da janela em UTC.

ClusterMaintenanceSchedule

Próxima manutenção programada.

Representação JSON
{
  "startTime": string,
  "endTime": string
}
Campos
startTime

string (Timestamp format)

Apenas saída. O horário de início de qualquer manutenção agendada futura dessa instância.

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

endTime

string (Timestamp format)

Apenas saída. O horário de término de qualquer manutenção programada futura para esta instância.

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

PscServiceAttachment

Configuração de um anexo de serviço do cluster para criar conexões do PSC.

Representação JSON
{
  "serviceAttachment": string,
  "connectionType": enum (ConnectionType)
}
Campos
serviceAttachment

string

Apenas saída. URI do anexo de serviço que sua PscConnection criada por você mesmo deve usar como destino.

connectionType

enum (ConnectionType)

Apenas saída. Tipo de uma conexão do PSC que segmenta este anexo de serviço.

ClusterEndpoint

O ClusterEndpoint consiste em conexões PSC criadas como um grupo em cada rede VPC para acessar o cluster. Em cada grupo, haverá uma conexão para cada anexo de serviço no cluster.

Representação JSON
{
  "connections": [
    {
      object (ConnectionDetail)
    }
  ]
}
Campos
connections[]

object (ConnectionDetail)

Obrigatório. Um grupo de conexões do PSC. Eles são criados na mesma rede VPC, um para cada anexo de serviço no cluster.

ConnectionDetail

Informações detalhadas de cada conexão do PSC.

Representação JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "pscAutoConnection": {
    object (PscAutoConnection)
  },
  "pscConnection": {
    object (PscConnection)
  }
  // End of mutually exclusive fields.
}
Campos
Uma conexão da PSC com um cluster pode ser criada pela automação de conectividade de serviço (conexão registrada automaticamente) durante a criação do cluster ou pelo próprio cliente (conexão registrada pelo usuário). Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
pscAutoConnection

object (PscAutoConnection)

Informações detalhadas de uma conexão do PSC criada pela automação de conectividade do serviço.

pscConnection

object (PscConnection)

Informações detalhadas de uma conexão PSC criada pelo cliente proprietário do cluster.

Fim dos campos mutuamente exclusivos.

PscAutoConnection

Detalhes dos recursos do consumidor em uma conexão do PSC criada pela automação de conectividade do serviço.

Representação JSON
{
  "pscConnectionId": string,
  "address": string,
  "forwardingRule": string,
  "projectId": string,
  "network": string,
  "serviceAttachment": string,
  "pscConnectionStatus": enum (PscConnectionStatus),
  "connectionType": enum (ConnectionType)
}
Campos
pscConnectionId

string

Apenas saída. O ID da conexão PSC da regra de encaminhamento conectada ao anexo de serviço.

address

string

Apenas saída. O IP alocado na rede do consumidor para a regra de encaminhamento do PSC.

forwardingRule

string

Apenas saída. O URI da regra de encaminhamento do lado do consumidor. Exemplo: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}.

projectId

string

Obrigatório. O consumerProjectId de onde a regra de encaminhamento é criada.

network

string

Obrigatório. A rede do consumidor em que o endereço IP reside, no formato projects/{projectId}/global/networks/{network_id}.

serviceAttachment

string

Apenas saída. O anexo de serviço que é o destino da conexão PSC, no formato projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}.

pscConnectionStatus

enum (PscConnectionStatus)

Apenas saída. O status da conexão do PSC. Esse valor é atualizado periodicamente. Use as APIs do Private Service Connect para conferir o status mais recente.

connectionType

enum (ConnectionType)

Apenas saída. Tipo da conexão PSC.

AutomatedBackupConfig

A configuração de backup automático de um cluster.

Representação JSON
{
  "automatedBackupMode": enum (AutomatedBackupMode),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "fixedFrequencySchedule": {
    object (FixedFrequencySchedule)
  }
  // End of mutually exclusive fields.
  "retention": string
}
Campos
automatedBackupMode

enum (AutomatedBackupMode)

Opcional. O modo de backup automatizado. Se o modo estiver desativado, os outros campos serão ignorados.

A programação de backups automatizados. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
fixedFrequencySchedule

object (FixedFrequencySchedule)

Opcional. Acionar backups automatizados com uma frequência fixa.

Fim dos campos mutuamente exclusivos.
retention

string (Duration format)

Opcional. Por quanto tempo manter os backups automatizados antes que eles sejam excluídos. O valor precisa estar entre 1 dia e 365 dias. Se não for especificado, o valor padrão será de 35 dias.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

FixedFrequencySchedule

Com essa programação, o backup é acionado em uma frequência fixa (atualmente, apenas diária).

Representação JSON
{
  "startTime": {
    object (TimeOfDay)
  }
}
Campos
startTime

object (TimeOfDay)

Obrigatório. O horário de início de cada backup automatizado em UTC. Ele precisa ser definido para o início de uma hora. Este campo é obrigatório.

AutomatedBackupMode

O modo de backup automatizado.

Tipos enumerados
AUTOMATED_BACKUP_MODE_UNSPECIFIED Valor padrão. A configuração de backup automatizado não foi especificada.
DISABLED Configuração de backup automatizado desativada.
ENABLED A configuração de backup automático está ativada.

ServerCaMode

Modo de AC do servidor para o cluster.

Tipos enumerados
SERVER_CA_MODE_UNSPECIFIED O modo da AC do servidor não foi especificado.
SERVER_CA_MODE_GOOGLE_MANAGED_PER_INSTANCE_CA Cada cluster tem uma AC gerenciada pelo Google.
SERVER_CA_MODE_GOOGLE_MANAGED_SHARED_CA O cluster usa a AC compartilhada gerenciada pelo Google na região.
SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA O cluster usa uma CA gerenciada pelo cliente do CAS.

AclPolicyInfo

Detalhes da política de ACL aplicada.

Representação JSON
{
  "appliedAclPolicy": string,
  "appliedAclPolicyRevision": string,
  "appliedAclPolicyRevisionNumber": string,
  "aclPolicyRevisionStatuses": [
    {
      object (AclPolicyRevisionStatus)
    }
  ]
}
Campos
appliedAclPolicy

string

Apenas saída. O nome do recurso da política de ACL aplicada. Formato: "projects/{project}/locations/{location}/aclPolicies/{aclPolicy}"

appliedAclPolicyRevision

string

Apenas saída. O nome do recurso da revisão da política de ACL aplicada. Formato: "projects/{project}/locations/{location}/aclPolicies/{aclPolicy}/revisions/{revision}"

appliedAclPolicyRevisionNumber

string (int64 format)

Apenas saída. O número da revisão da política de ACL aplicada.

aclPolicyRevisionStatuses[]

object (AclPolicyRevisionStatus)

Apenas saída. Uma lista de status para várias revisões dessa política de ACL no cluster.

Métodos

addTokenAuthUser

Adiciona um usuário de autenticação por token a um cluster com autenticação por token ativada.

backup

Faça backup do cluster do Redis.

create

Cria um cluster do Redis com base nas propriedades especificadas.

delete

Exclui um cluster do Redis específico.

get

Recebe os detalhes de um cluster do Redis específico.

getCertificateAuthority

Recebe os detalhes das informações da autoridade certificadora para o cluster do Redis.

list

Lista todos os clusters do Redis pertencentes a um projeto no local especificado (região) ou em todos os locais.

patch

Atualiza os metadados e a configuração de um cluster do Redis específico.

rescheduleClusterMaintenance

Reprograma o próximo evento de manutenção.