REST Resource: projects.locations.instances

Recurso: Instance

Una instancia de Memorystore para Memcached

Representación JSON 
{
  "name": string,
  "displayName": string,
  "labels": {
    string: string,
    ...
  },
  "authorizedNetwork": string,
  "zones": [
    string
  ],
  "nodeCount": integer,
  "nodeConfig": {
    object (NodeConfig)
  },
  "memcacheVersion": enum (MemcacheVersion),
  "parameters": {
    object (MemcacheParameters)
  },
  "memcacheNodes": [
    {
      object (Node)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "state": enum (State),
  "memcacheFullVersion": string,
  "instanceMessages": [
    {
      object (InstanceMessage)
    }
  ],
  "discoveryEndpoint": string,
  "updateAvailable": boolean,
  "maintenancePolicy": {
    object (MaintenancePolicy)
  },
  "maintenanceSchedule": {
    object (MaintenanceSchedule)
  },
  "reservedIpRangeId": [
    string
  ],
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean
}
Campos
name

string

Obligatorio. Nombre único del recurso en este ámbito, incluidos el proyecto y la ubicación, con el formato projects/{projectId}/locations/{locationId}/instances/{instanceId}.

Nota: Las instancias de Memcached se gestionan y se dirigen a nivel regional, por lo que locationId hace referencia a una región de Google Cloud. Sin embargo, los usuarios pueden elegir en qué zonas se deben aprovisionar los nodos de Memcached de una instancia. Consulta el campo zones para obtener más información.
displayName

string

Nombre proporcionado por el usuario para la instancia, que solo se usa con fines de visualización. No puede tener más de 80 caracteres.
labels

map (key: string, value: string)

Etiquetas de recursos para representar metadatos proporcionados por el usuario. Consulta la documentación de Cloud sobre etiquetas para obtener más información: https://cloud.google.com/compute/docs/labeling-resources.

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

string

Nombre completo de la red de Google Compute Engine a la que está conectada la instancia. Si no se especifica, se usará la red default.
zones[]

string

Zonas en las que se deben aprovisionar los nodos de Memcached. Los nodos de Memcached se distribuirán de forma equitativa entre estas zonas. Si no se proporciona, el servicio creará nodos de forma predeterminada en todas las zonas de la región de la instancia.
nodeCount

integer

Obligatorio. Número de nodos de la instancia de Memcached.
nodeConfig

object (NodeConfig)

Obligatorio. Configuración de los nodos de Memcached.
memcacheVersion

enum (MemcacheVersion)

Versión principal del software Memcached. Si no se proporciona ninguna, se usará la versión más reciente admitida. Actualmente, la última versión principal compatible es MEMCACHE_1_5. Nuestro sistema determinará automáticamente la versión secundaria en función de la última versión secundaria compatible.
parameters

object (MemcacheParameters)

Parámetros definidos por el usuario que se aplicarán al proceso de memcached en cada nodo.
memcacheNodes[]

object (Node)

Solo de salida. Lista de nodos de Memcached. Consulta el mensaje Node para obtener más información.
createTime

string (Timestamp format)

Solo de salida. Hora en la que se creó la instancia.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo de salida. Hora en la que se actualizó la instancia.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
state

enum (State)

Solo de salida. Estado de esta instancia de Memcached.
memcacheFullVersion

string

Solo de salida. La versión completa del servidor memcached que se ejecuta en esta instancia. El sistema determina automáticamente la versión completa de Memcached de una instancia en función del valor de MemcacheVersion. El formato de la versión completa será "memcached-1.5.16".
instanceMessages[]

object (InstanceMessage)

Lista de mensajes que describen el estado actual de la instancia de Memcached.
discoveryEndpoint

string

Solo de salida. Punto de conexión de la API Discovery.
updateAvailable

boolean

Solo de salida. Devuelve true si hay una actualización pendiente de aplicar.
maintenancePolicy

object (MaintenancePolicy)

Política de mantenimiento de la instancia. Si no se proporciona, el evento de mantenimiento se realizará según la programación de lanzamiento interna de Memorystore.
maintenanceSchedule

object (MaintenanceSchedule)

Solo de salida. Calendario de mantenimiento publicado.
reservedIpRangeId[]

string

Opcional. Contiene el ID de los intervalos de direcciones IP asignados asociados a la conexión de acceso a servicios privados. Por ejemplo, "test-default" asociado al intervalo de IP 10.0.0.0/29.
satisfiesPzs

boolean

Opcional. Solo de salida. Reservado para uso futuro.
satisfiesPzi

boolean

Opcional. Solo de salida. Reservado para uso futuro.

NodeConfig

Configuración de un nodo de Memcached.

Representación JSON 
{
  "cpuCount": integer,
  "memorySizeMb": integer
}
Campos
cpuCount

integer

Obligatorio. Número de CPUs por nodo de Memcached.
memorySizeMb

integer

Obligatorio. Tamaño de la memoria en MiB de cada nodo de Memcached.

MemcacheVersion

Versiones de Memcached compatibles con nuestro servicio.

Enumeraciones
MEMCACHE_VERSION_UNSPECIFIED El cliente no ha especificado la versión de Memcache
MEMCACHE_1_5 Versión 1.5 de Memcached.
MEMCACHE_1_6_15 Versión 1.6.15 de Memcached.

MemcacheParameters

Representación JSON 
{
  "id": string,
  "params": {
    string: string,
    ...
  }
}
Campos
id

string

Solo de salida. ID único asociado a este conjunto de parámetros. Los usuarios pueden usar este ID para determinar si los parámetros asociados a la instancia difieren de los parámetros asociados a los nodos. Si hay una discrepancia entre los IDs de los parámetros, se puede informar a los usuarios de que deben tomar medidas para aplicar los parámetros en los nodos.
params

map (key: string, value: string)

Conjunto de parámetros definidos por el usuario que se utilizarán en el proceso de memcached.

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

Node

Representación JSON 
{
  "nodeId": string,
  "zone": string,
  "state": enum (State),
  "host": string,
  "port": integer,
  "parameters": {
    object (MemcacheParameters)
  },
  "updateAvailable": boolean,
  "memcacheVersion": enum (MemcacheVersion),
  "memcacheFullVersion": string
}
Campos
nodeId

string

Solo de salida. Identificador del nodo de Memcached. El ID de nodo no incluye el proyecto ni la ubicación, como el nombre de la instancia de Memcached.
zone

string

Solo de salida. Ubicación (zona de GCP) del nodo de Memcached.
state

enum (State)

Solo de salida. Estado actual del nodo de Memcached.
host

string

Solo de salida. Nombre de host o dirección IP del nodo de Memcached que usan los clientes para conectarse al servidor de Memcached en este nodo.
port

integer

Solo de salida. El número de puerto del servidor Memcached en este nodo.
parameters

object (MemcacheParameters)

Parámetros definidos por el usuario que se aplican actualmente al nodo.
updateAvailable

boolean

Solo de salida. Devuelve true si hay una actualización pendiente de aplicar.
memcacheVersion

enum (MemcacheVersion)

Solo de salida. Versión principal del servidor memcached que se ejecuta en este nodo (por ejemplo, MEMCACHE_1_5).
memcacheFullVersion

string

Solo de salida. La versión completa del servidor memcached que se ejecuta en este nodo. Por ejemplo, memcached-1.5.16.

Estado

Diferentes estados de un nodo de Memcached.

Enumeraciones
STATE_UNSPECIFIED El estado del nodo no se ha definido.
CREATING Se está creando el nodo.
READY El nodo se ha creado y está listo para usarse.
DELETING Se está eliminando el nodo.
UPDATING El nodo se está actualizando.

Estado

Diferentes estados de una instancia de Memcached.

Enumeraciones
STATE_UNSPECIFIED Estado no definido.
CREATING Se está creando la instancia de Memcached.
READY Se ha creado la instancia de Memcached y ya se puede usar.
UPDATING La instancia de Memcached está actualizando la configuración, como la política y la programación de mantenimiento.
DELETING Se está eliminando la instancia de Memcached.
PERFORMING_MAINTENANCE La instancia de Memcached está en mantenimiento (por ejemplo, se está implementando el plano de datos).
MEMCACHE_VERSION_UPGRADING La instancia de Memcached está actualizando la versión del motor de Memcached.

InstanceMessage

Representación JSON 
{
  "code": enum (Code),
  "message": string
}
Campos
code

enum (Code)

Código que corresponde a un tipo de mensaje visible para el usuario.
message

string

Mensaje de la instancia de memcached que se mostrará a los usuarios.

Código

Enumeraciones
CODE_UNSPECIFIED No se ha definido el código de mensaje.
ZONE_DISTRIBUTION_UNBALANCED Los nodos de Memcached se distribuyen de forma desigual.

MaintenancePolicy

Política de mantenimiento por instancia.

Representación JSON 
{
  "createTime": string,
  "updateTime": string,
  "description": string,
  "weeklyMaintenanceWindow": [
    {
      object (WeeklyMaintenanceWindow)
    }
  ]
}
Campos
createTime

string (Timestamp format)

Solo de salida. Hora en la que se creó la política.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo de salida. Hora en la que se actualizó la política.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
description

string

Descripción de la finalidad de esta política. Los métodos de creación o actualización devuelven INVALID_ARGUMENT si la longitud es superior a 512.
weeklyMaintenanceWindow[]

object (WeeklyMaintenanceWindow)

Obligatorio. Ventana de mantenimiento que se aplica a los recursos cubiertos por esta política. Mínimo 1. En la versión actual, el número máximo de weekly_maintenance_windows es uno.

WeeklyMaintenanceWindow

Periodo especificado para las operaciones semanales.

Representación JSON 
{
  "day": enum (DayOfWeek),
  "startTime": {
    object (TimeOfDay)
  },
  "duration": string
}
Campos
day

enum (DayOfWeek)

Obligatorio. Permite definir una programación que se ejecute un día de la semana específico.
startTime

object (TimeOfDay)

Obligatorio. Hora de inicio del intervalo en UTC.
duration

string (Duration format)

Obligatorio. Duración del periodo.

Duración en segundos con hasta nueve decimales, que termina con "s". Por ejemplo: "3.5s".

MaintenanceSchedule

Calendario de mantenimiento próximo.

Representación JSON 
{
  "startTime": string,
  "endTime": string,
  "scheduleDeadlineTime": string
}
Campos
startTime

string (Timestamp format)

Solo de salida. Hora de inicio de cualquier mantenimiento programado para esta instancia.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Solo de salida. Hora de finalización de cualquier mantenimiento programado para esta instancia.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
scheduleDeadlineTime

string (Timestamp format)

Solo de salida. La fecha límite que no puede superar la hora de inicio de la programación del mantenimiento, incluida la reprogramación.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

Métodos

applyParameters

 ApplyParameters reinicia el conjunto de nodos especificados para actualizarlos al conjunto de parámetros actual de la instancia de Memcached.

applySoftwareUpdate

 Actualiza el software de los nodos seleccionados de la instancia.

create

 Crea una instancia en una ubicación determinada.

delete

 Elimina una sola instancia.

get

 Obtiene los detalles de una sola instancia.

list

 Muestra las instancias de una ubicación determinada.

patch

 Actualiza una instancia en un proyecto y una ubicación determinados.

rescheduleMaintenance

 Realiza la fase de aplicación del verbo RescheduleMaintenance.

updateParameters

 Actualiza los parámetros de Memcached definidos de una instancia.

upgrade

 Actualiza la instancia de Memcache a una versión más reciente del motor de memcached especificada en la solicitud.