REST Resource: projects.locations.instances

Recurso: Instancia

Una instancia de Memorystore

Representación 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)
    }
  ],
  "replicaCount": integer,
  "deletionProtectionEnabled": boolean
}
Campos
name

string

Identificador. Es el nombre único de la instancia. Formato: projects/{project}/locations/{location}/instances/{instance}
createTime

string (Timestamp format)

Solo salida. Marca de tiempo de creación de la instancia.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Solo salida. Marca de tiempo de la actualización más reciente de la instancia.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
labels

map (key: string, value: string)

Opcional. Son etiquetas para representar los metadatos proporcionados por el usuario.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
state

enum (State)

Solo salida. Estado actual de la instancia.
stateInfo

object (StateInfo)

Solo salida. Información adicional sobre el estado de la instancia.
uid

string

Solo salida. Es el identificador único asignado por el sistema para la instancia.
authorizationMode

enum (AuthorizationMode)

Opcional. Inmutable. Modo de autorización de la instancia.
transitEncryptionMode

enum (TransitEncryptionMode)

Opcional. Inmutable. Modo de encriptación en tránsito de la instancia.
shardCount

integer

Obligatorio. Cantidad de fragmentos de la instancia.
discoveryEndpoints[]

object (DiscoveryEndpoint)

Solo salida. Los clientes de Endpoints pueden conectarse a la instancia. Actualmente, solo se admite un extremo de descubrimiento.
nodeType

enum (NodeType)

Opcional. Inmutable. Es el tipo de máquina para los nodos individuales de la instancia.
persistenceConfig

object (PersistenceConfig)

Opcional. Configuración de persistencia de la instancia.
engineVersion

string

Opcional. Inmutable. Es la versión del motor de la instancia.
engineConfigs

map (key: string, value: string)

Opcional. Son las configuraciones del motor proporcionadas por el usuario para la instancia.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
nodeConfig

object (NodeConfig)

Solo salida. Configuración de los nodos individuales de la instancia.
zoneDistributionConfig

object (ZoneDistributionConfig)

Opcional. Inmutable. Configuración de distribución de zona de la instancia para la asignación de nodos.
pscAutoConnections[]

object (PscAutoConnection)

Obligatorio. Inmutable. Entradas del usuario y detalles de los recursos de las conexiones PSC creadas automáticamente.
replicaCount

integer

Opcional. Cantidad de nodos de réplica por fragmento. Si se omite, el valor predeterminado es 0 réplicas.
deletionProtectionEnabled

boolean

Opcional. Si se establece como verdadero, la eliminación de la instancia fallará.

Estado

Estados posibles de la instancia.

Enums
STATE_UNSPECIFIED Sin establecer
CREATING Se está creando la instancia.
ACTIVE Se creó la instancia y se puede usar.
UPDATING Se está actualizando la instancia.
DELETING Se está borrando la instancia.

StateInfo

Información adicional sobre el estado de la instancia.

Representación 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ón info.

info puede ser una de las siguientes opciones:
updateInfo

object (UpdateInfo)

Solo salida. Describe la actualización en curso cuando el estado de la instancia es UPDATING.

UpdateInfo

Representa información sobre la instancia con el estado UPDATING.

Representación JSON 
{
  "targetShardCount": integer,
  "targetReplicaCount": integer
}
Campos
targetShardCount

integer

Solo salida. Cantidad objetivo de fragmentos para la instancia.
targetReplicaCount

integer

Solo salida. Es la cantidad objetivo de nodos de réplica por fragmento para la instancia.

AuthorizationMode

Posibles modos de autorización de la instancia.

Enums
AUTHORIZATION_MODE_UNSPECIFIED Sin establecer
AUTH_DISABLED Se inhabilitó la autorización.
IAM_AUTH Autorización básica de IAM

TransitEncryptionMode

Posibles modos de encriptación en tránsito de la instancia.

Enums
TRANSIT_ENCRYPTION_MODE_UNSPECIFIED Sin establecer
TRANSIT_ENCRYPTION_DISABLED La encriptación en tránsito está inhabilitada.
SERVER_AUTHENTICATION La encriptación administrada por el servidor se usa para la encriptación en tránsito.

DiscoveryEndpoint

Representa un extremo para que los clientes se conecten a la instancia.

Representación JSON 
{
  "address": string,
  "port": integer,
  "network": string
}
Campos
address

string

Solo salida. Es la dirección IP del extremo expuesto al que se conectan los clientes.
port

integer

Solo salida. El número de puerto del extremo expuesto.
network

string

Solo salida. La red en la que se reservará la dirección IP del extremo de detección, en el formato projects/{networkProject}/global/networks/{network_id}.

NodeType

Son los posibles tipos de nodos de la instancia. Consulta https://cloud.google.com/memorystore/docs/valkey/instance-node-specification para obtener más información.

Enums
NODE_TYPE_UNSPECIFIED Sin establecer
SHARED_CORE_NANO Nano con núcleo compartido.
HIGHMEM_MEDIUM Medio con alta capacidad de memoria.
HIGHMEM_XLARGE Memoria alta extragrande
STANDARD_SMALL Estándar pequeño

PersistenceConfig

Representa la configuración de persistencia de una instancia.

Representación JSON 
{
  "mode": enum (PersistenceMode),
  "rdbConfig": {
    object (RDBConfig)
  },
  "aofConfig": {
    object (AOFConfig)
  }
}
Campos
mode

enum (PersistenceMode)

Opcional. Modo de persistencia actual.
rdbConfig

object (RDBConfig)

Opcional. Configuración de RDB Este campo se ignorará si el modo no es RDB.
aofConfig

object (AOFConfig)

Opcional. Configuración de AOF. Este campo se ignorará si el modo no es AOF.

PersistenceMode

Modos de persistencia posibles.

Enums
PERSISTENCE_MODE_UNSPECIFIED Sin establecer
DISABLED Se inhabilita la persistencia y se borran los datos de las instantáneas.
RDB La persistencia basada en RDB está habilitada.
AOF La persistencia basada en AOF está habilitada.

RDBConfig

Configuración de persistencia basada en RDB.

Representación JSON 
{
  "rdbSnapshotPeriod": enum (SnapshotPeriod),
  "rdbSnapshotStartTime": string
}
Campos
rdbSnapshotPeriod

enum (SnapshotPeriod)

Opcional. Es el período entre instantáneas de la RDB.
rdbSnapshotStartTime

string (Timestamp format)

Opcional. Hora en que se intentará o intentará la primera instantánea y a la que se alinearán las instantáneas futuras. Si no se proporciona, se usará la hora actual.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

SnapshotPeriod

Posibles períodos de instantáneas

Enums
SNAPSHOT_PERIOD_UNSPECIFIED Sin establecer
ONE_HOUR Una hora.
SIX_HOURS Seis horas.
TWELVE_HOURS Doce horas.
TWENTY_FOUR_HOURS Veinticuatro horas.

AOFConfig

Configuración para la persistencia basada en AOF

Representación JSON 
{
  "appendFsync": enum (AppendFsync)
}
Campos
appendFsync

enum (AppendFsync)

Opcional. El modo fsync.

AppendFsync

Modos fsync posibles.

Enums
APPEND_FSYNC_UNSPECIFIED Sin establecer Valor predeterminado: EVERY_SEC
NEVER Nunca uses fsync. Por lo general, Linux borra los datos cada 30 segundos con esta configuración, pero depende de la configuración exacta del kernel.
EVERY_SEC fsync cada segundo. Si ocurre un desastre, es posible que pierdas 1 segundo de datos.
ALWAYS Fsync cada vez que se agregan nuevos comandos de escritura a la AOF. La mejor protección contra la pérdida de datos a costa del rendimiento.

NodeConfig

Representa la configuración de los nodos de la instancia.

Representación JSON 
{
  "sizeGb": number
}
Campos
sizeGb

number

Solo salida. Tamaño de memoria del nodo en GB.

ZoneDistributionConfig

Configuración de distribución por zonas para asignar recursos de instancia.

Representación JSON 
{
  "zone": string,
  "mode": enum (ZoneDistributionMode)
}
Campos
zone

string

Opcional. Define la zona en la que se asignarán todos los recursos con el modo SINGLE_ZONE. Se ignora para el modo MULTI_ZONE.
mode

enum (ZoneDistributionMode)

Opcional. Modo de distribución de la zona actual. El valor predeterminado es MULTI_ZONE.

ZoneDistributionMode

Posibles modos de distribución de zonas.

Enums
ZONE_DISTRIBUTION_MODE_UNSPECIFIED Sin establecer. Valor predeterminado: MULTI_ZONE
MULTI_ZONE Distribuye los recursos en 3 zonas elegidas al azar dentro de la región.
SINGLE_ZONE Aprovisiona recursos en una sola zona. Se debe especificar el campo de zona.

PscAutoConnection

Detalles de los recursos del consumidor en una conexión de PSC.

Representación JSON 
{
  "pscConnectionId": string,
  "ipAddress": string,
  "forwardingRule": string,
  "projectId": string,
  "network": string
}
Campos
pscConnectionId

string

Solo salida. El ID de conexión de PSC de la regla de reenvío conectada al adjunto de servicio.
ipAddress

string

Solo salida. Es la IP asignada en la red del consumidor para la regla de reenvío de PSC.
forwardingRule

string

Solo salida. El URI de la regla de reenvío del consumidor. Formato: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
projectId

string

Obligatorio. El projectId del consumidor desde el que se crea la regla de reenvío.
network

string

Obligatorio. La red del consumidor en la que reside la dirección IP, en el formato projects/{projectId}/global/networks/{network_id}.

Métodos

create

 Crea una instancia nueva en un proyecto y una ubicación determinados.

delete

 Borra una sola instancia.

get

 Obtiene los detalles de una sola instancia.

getCertificateAuthority

 Obtiene detalles sobre la autoridad certificadora de una instancia.

list

 Enumera instancias en una ubicación y un proyecto determinados.

patch

 Actualiza los parámetros de una sola instancia.