REST Resource: projects.locations.instances

Recurso: instância

Uma instância do Memorystore.

Representação JSON 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "state": enum (State),
  "stateInfo": {
    object (StateInfo)
  },
  "uid": string,
  "authorizationMode": enum (AuthorizationMode),
  "transitEncryptionMode": enum (TransitEncryptionMode),
  "shardCount": integer,
  "discoveryEndpoints": [
    {
      object (DiscoveryEndpoint)
    }
  ],
  "nodeType": enum (NodeType),
  "persistenceConfig": {
    object (PersistenceConfig)
  },
  "engineVersion": string,
  "engineConfigs": {
    string: string,
    ...
  },
  "nodeConfig": {
    object (NodeConfig)
  },
  "zoneDistributionConfig": {
    object (ZoneDistributionConfig)
  },
  "pscAutoConnections": [
    {
      object (PscAutoConnection)
    }
  ],
  "endpoints": [
    {
      object (InstanceEndpoint)
    }
  ],
  "mode": enum (Mode),
  "replicaCount": integer,
  "deletionProtectionEnabled": boolean
}
Campos
name

string

Identificador. Nome exclusivo da instância. Formato: projects/{project}/locations/{location}/instances/{instance}
createTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora de criação da instância.

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. Carimbo de data/hora da última atualização da instância.

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

enum (State)

Apenas saída. Estado atual da instância.
stateInfo

object (StateInfo)

Apenas saída. Outras informações sobre o estado da instância.
uid

string

Apenas saída. Identificador exclusivo atribuído pelo sistema para a instância.
authorizationMode

enum (AuthorizationMode)

Opcional. Imutável. Modo de autorização da instância.
transitEncryptionMode

enum (TransitEncryptionMode)

Opcional. Imutável. Modo de criptografia em trânsito da instância.
shardCount

integer

Opcional. Número de fragmentos da instância.
discoveryEndpoints[]

object (DiscoveryEndpoint)

Apenas saída. Endpoints aos quais os clientes podem se conectar à instância. No momento, só é possível usar um endpoint de descoberta.
nodeType

enum (NodeType)

Opcional. Imutável. Tipo de máquina para nós individuais da instância.
persistenceConfig

object (PersistenceConfig)

Opcional. Configuração de persistência da instância.
engineVersion

string

Opcional. Imutável. Versão do mecanismo da instância.
engineConfigs

map (key: string, value: string)

Opcional. Configurações do mecanismo fornecidas pelo usuário para a instância.

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

object (NodeConfig)

Apenas saída. Configuração de nós individuais da instância.
zoneDistributionConfig

object (ZoneDistributionConfig)

Opcional. Imutável. Configuração da distribuição de zonas da instância para a alocação de nós.
pscAutoConnections[]

object (PscAutoConnection)

Obrigatório. Imutável. Entradas do usuário e detalhes de recursos das conexões de PSC criadas automaticamente.
endpoints[]

object (InstanceEndpoint)

Opcional. Endpoints da instância.
mode

enum (Mode)

Opcional. A configuração de modo da instância.
replicaCount

integer

Opcional. Número de nós de réplica por fragmento. Se omitido, o padrão é 0 réplicas.
deletionProtectionEnabled

boolean

Opcional. Se definido como verdadeiro, a exclusão da instância vai falhar.

Estado

Estados possíveis da instância.

Enums
STATE_UNSPECIFIED Não definido
CREATING A instância está sendo criada.
ACTIVE A instância foi criada e pode ser usada.
UPDATING A instância está sendo atualizada.
DELETING A instância está sendo excluída.

StateInfo

Outras informações sobre o estado da instância.

Representação JSON 
{

  // Union field info can be only one of the following:
  "updateInfo": {
    object (UpdateInfo)
  }
  // End of list of possible types for union field info.
}
Campos

Campo de união info.

info pode ser apenas de um dos tipos a seguir:
updateInfo

object (UpdateInfo)

Apenas saída. Descreve a atualização em andamento quando o estado da instância está em UPDATING.

UpdateInfo

Representa informações sobre a instância com o estado UPDATING.

Representação JSON 
{
  "targetShardCount": integer,
  "targetReplicaCount": integer
}
Campos
targetShardCount

integer

Apenas saída. Número de fragmentos de destino para a instância.
targetReplicaCount

integer

Apenas saída. Número de nós de réplica por fragmento para a instância.

AuthorizationMode

Possíveis modos de autorização da instância.

Enums
AUTHORIZATION_MODE_UNSPECIFIED Não definido
AUTH_DISABLED Autorização desativada.
IAM_AUTH Autorização básica do IAM.

TransitEncryptionMode

Possíveis modos de criptografia em trânsito da instância.

Enums
TRANSIT_ENCRYPTION_MODE_UNSPECIFIED Não definido
TRANSIT_ENCRYPTION_DISABLED A criptografia em trânsito está desativada.
SERVER_AUTHENTICATION A criptografia gerenciada pelo servidor é usada para criptografia em trânsito.

DiscoveryEndpoint

Representa um endpoint para os clientes se conectarem à instância.

Representação JSON 
{
  "address": string,
  "port": integer,
  "network": string
}
Campos
address

string

Apenas saída. Endereço IP do endpoint exposto ao qual os clientes se conectam.
port

integer

Apenas saída. O número da porta do endpoint exposto.
network

string

Apenas saída. A rede em que o endereço IP do endpoint de descoberta será reservado, no formato projects/{networkProject}/global/networks/{network_id}.

NodeType

Possíveis tipos de nó da instância. Consulte https://cloud.google.com/memorystore/docs/valkey/instance-node-specification para mais informações.

Enums
NODE_TYPE_UNSPECIFIED Não definido
SHARED_CORE_NANO Nano de núcleo compartilhado.
HIGHMEM_MEDIUM Memória alta.
HIGHMEM_XLARGE Alta memória extra grande.
STANDARD_SMALL Padrão pequeno.

PersistenceConfig

Representa a configuração de persistência de uma instância.

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

enum (PersistenceMode)

Opcional. Modo de persistência atual.
rdbConfig

object (RDBConfig)

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

object (AOFConfig)

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

PersistenceMode

Possíveis modos de persistência.

Enums
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 para persistência baseada em RDB.

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

enum (SnapshotPeriod)

Opcional. Período entre os snapshots do RDB.
rdbSnapshotStartTime

string (Timestamp format)

Opcional. Hora em que a primeira tentativa de criação do snapshot foi feita e a que os futuros snapshots serão alinhados. Se não for fornecido, o horário atual será usado.

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

SnapshotPeriod

Possíveis períodos de snapshot.

Enums
SNAPSHOT_PERIOD_UNSPECIFIED Não definido
ONE_HOUR Uma hora.
SIX_HOURS Seis horas.
TWELVE_HOURS Doze horas.
TWENTY_FOUR_HOURS Vinte e quatro horas.

AOFConfig

Configuração para a persistência baseada em AOF.

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

enum (AppendFsync)

Opcional. O modo fsync.

AppendFsync

Possíveis modos de sincronização de arquivos.

Enums
APPEND_FSYNC_UNSPECIFIED Não definido Padrão: EVERY_SEC
NEVER Nunca fsync. Normalmente, o Linux vai limpar os dados a cada 30 segundos com essa configuração, mas isso depende do ajuste exato do kernel.
EVERY_SEC Fsync a cada segundo. Você pode perder um segundo de dados em caso de desastre.
ALWAYS Fsync sempre que novos comandos de gravação são anexados ao AOF. A melhor proteção contra perda de dados com custo de desempenho.

NodeConfig

Representa a configuração dos nós da instância.

Representação JSON 
{
  "sizeGb": number
}
Campos
sizeGb

number

Apenas saída. Tamanho da memória em GB do nó.

ZoneDistributionConfig

Configuração da distribuição de zonas para a alocação de recursos de instância.

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

string

Opcional. Define a zona em que todos os recursos serão alocados com o modo SINGLE_ZONE. Ignorado para o modo MULTI_ZONE.
mode

enum (ZoneDistributionMode)

Opcional. Modo de distribuição de zona atual. O padrão é MULTI_ZONE.

ZoneDistributionMode

Possíveis modos de distribuição de zonas.

Enums
ZONE_DISTRIBUTION_MODE_UNSPECIFIED Não definido. Padrão: MULTI_ZONE
MULTI_ZONE Distribua os recursos em três zonas escolhidas aleatoriamente na região.
SINGLE_ZONE Provisionar recursos em uma única zona. O campo de zona precisa ser especificado.

PscAutoConnection

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

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

  // Union field ports can be only one of the following:
  "port": integer
  // End of list of possible types for union field ports.
}
Campos
pscConnectionId

string

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

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. Formato: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
projectId

string

Obrigatório. O projectId do consumidor em que as conexões PSC são estabelecidas. Precisa ser o mesmo projectId em que a instância está sendo criada.
network

string

Obrigatório. A rede em que os endpoints do PSC são criados, 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 PSC: se uma conexão existe e está ATIVO ou se ela não existe mais. Esse valor é atualizado periodicamente. Use as APIs do Private Service Connect para conferir o status mais recente.
connectionType

enum (ConnectionType)

Apenas saída. Tipo de conexão PSC.
Campo de união ports. Portas do endpoint exposto. ports pode ser apenas de um dos tipos a seguir:
port

integer

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

PscConnectionStatus

Status da conexão do PSC.

Enums
PSC_CONNECTION_STATUS_UNSPECIFIED O status da conexão com o PSC não foi especificado.
ACTIVE A conexão está ativa
NOT_FOUND Conexão não encontrada

ConnectionType

Tipo de conexão PSC

Enums
CONNECTION_TYPE_UNSPECIFIED O tipo de conexão não está definido
CONNECTION_TYPE_DISCOVERY Conexão que será usada para a descoberta de topologia.
CONNECTION_TYPE_PRIMARY Conexão que será usada como endpoint principal para acessar o principal.
CONNECTION_TYPE_READER Conexão que será usada como endpoint de leitor para acessar as réplicas.

InstanceEndpoint

O InstanceEndpoint consiste em conexões PSC criadas como um grupo em cada rede VPC para acessar a instância. 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)

Opcional. Um grupo de conexões de PSC. Elas são criadas na mesma rede VPC, uma para cada anexo de serviço no cluster.

ConnectionDetail

Informações de cada conexão PSC.

Representação JSON 
{

  // Union field connection can be only one of the following:
  "pscAutoConnection": {
    object (PscAutoConnection)
  },
  "pscConnection": {
    object (PscConnection)
  }
  // End of list of possible types for union field connection.
}
Campos
Campo de união connection. Uma conexão PSC com uma instância pode ser criada pela automação de conectividade de serviço (conexão automática) durante a criação do cluster ou pelo próprio cliente (conexão criada pelo usuário). connection pode ser apenas de um dos tipos a seguir:
pscAutoConnection

object (PscAutoConnection)

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

object (PscConnection)

Informações detalhadas de uma conexão PSC criada pelo usuário.

PscConnection

O usuário criou a configuração de conexão do Psc.

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

string

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

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. Formato: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
projectId

string

Apenas saída. O 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 está localizado, 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 PSC: se uma conexão existe e está ATIVO ou se ela não existe mais. 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.

Modo

A configuração do modo, que é usada para ativar/desativar o modo de cluster.

Enums
MODE_UNSPECIFIED O modo não foi especificado.
CLUSTER A instância está no modo cluster.
CLUSTER_DISABLED O modo cluster está desativado para a instância.

Métodos

create

 Cria uma nova instância em um determinado projeto e local.

delete

 Exclui uma única instância.

get

 Recebe detalhes de uma única instância.

getCertificateAuthority

 Recebe detalhes sobre a autoridade certificadora de uma instância.

list

 Lista instâncias em um determinado projeto e local.

patch

 Atualiza os parâmetros de uma única instância.