REST Resource: projects.locations.instances

Recurso: Instancia

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,
  "maintenancePolicy": {
    object (MaintenancePolicy)
  },
  "maintenanceSchedule": {
    object (MaintenanceSchedule)
  },
  "reservedIpRangeId": [
    string
  ]
}
Campos
name

string

Obligatorio Nombre único del recurso en este permiso, incluido el proyecto y la ubicación mediante el formulario: projects/{projectId}/locations/{locationId}/instances/{instanceId}

Nota: Las instancias de Memcached se administran y abordan a nivel regional, por lo que locationId aquí 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 dentro de una instancia. Consulta el campo zones para obtener más detalles.
displayName

string

El nombre que proporcionó 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)

Son las etiquetas de los recursos para representar los metadatos proporcionados por el usuario. Consulta la documentación de Cloud sobre etiquetas para obtener más detalles. 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

Es el nombre completo de la red de Google Compute Engine a la que se conecta 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 en todas las zonas de la región para la instancia de forma predeterminada.
nodeCount

integer

Obligatorio. Cantidad de nodos en la instancia de Memcached.
nodeConfig

object (NodeConfig)

Obligatorio Configuración de los nodos de Memcached
memcacheVersion

enum (MemcacheVersion)

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

object (MemcacheParameters)

Parámetros definidos por el usuario para aplicar al proceso Memcached en cada nodo.
memcacheNodes[]

object (Node)

Solo salida. Es la lista de nodos de Memcached. Consulta el mensaje Node para obtener más detalles.
createTime

string (Timestamp format)

Solo salida. Hora en la que se creó 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. La hora en la que se actualizó 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".
state

enum (State)

Solo salida. El estado de esta instancia de Memcached.
memcacheFullVersion

string

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

object (InstanceMessage)

Es una lista de mensajes que describen el estado actual de la instancia de Memcached.
discoveryEndpoint

string

Solo salida. Extremo para la API de Discovery.
maintenancePolicy

object (MaintenancePolicy)

La política de mantenimiento de la instancia. Si no se proporciona, el evento de mantenimiento se realizará según el programa de lanzamiento interno de Memorystore.
maintenanceSchedule

object (MaintenanceSchedule)

Solo salida. Programa de mantenimiento publicado.
reservedIpRangeId[]

string

Opcional. Contiene el ID de los rangos de direcciones IP asignados asociados con la conexión de acceso privado a servicios, por ejemplo, “test-default” asociada con el rango de IP 10.0.0.0/29.

NodeConfig

Configuración para un nodo de Memcached.

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

integer

Obligatorio Cantidad de CPU por nodo de Memcached.
memorySizeMb

integer

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

Versión de Memcache

Versiones de Memcached compatibles con nuestro servicio.

Enums
MEMCACHE_VERSION_UNSPECIFIED El cliente no especificó la versión de Memcache
MEMCACHE_1_5 Versión 1.5 de Memcached.
MEMCACHE_1_6_15 Memcached versión 1.6.15.

Parámetros de Memcache

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

string

Solo salida. El ID único asociado con este conjunto de parámetros. Los usuarios pueden usar este ID para determinar si los parámetros asociados con la instancia difieren de los parámetros asociados con los nodos. Una discrepancia entre los IDs de los parámetros puede informar a los usuarios que es posible que deban tomar medidas para aplicar parámetros en los nodos.
params

map (key: string, value: string)

Conjunto de parámetros definido por el usuario para usar en el proceso de Memcached.

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

Nodo

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

string

Solo salida. Es el identificador del nodo de Memcached. El ID del nodo no incluye el proyecto o la ubicación como el nombre de la instancia de Memcached.
zone

string

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

enum (State)

Solo salida. Estado actual del nodo de Memcached.
host

string

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

integer

Solo salida. Es 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.
memcacheVersion

enum (MemcacheVersion)

Solo salida. Es la versión principal del servidor de Memcached que se ejecuta en este nodo, p. ej., MEMCACHE_1_5.
memcacheFullVersion

string

Solo salida. Es la versión completa del servidor de Memcached que se ejecuta en este nodo. p. ej., memcached-1.5.16

Estado

Diferentes estados de un nodo de Memcached.

Enums
STATE_UNSPECIFIED No se estableció el estado del nodo.
CREATING Se está creando el nodo.
READY Se creó el nodo y está listo para usarse.
DELETING Se está borrando el nodo.
UPDATING Se está actualizando el nodo.

State

Diferentes estados de una instancia de Memcached.

Enums
STATE_UNSPECIFIED El estado no se estableció.
CREATING Se está creando la instancia de Memcached.
READY Se creó la instancia de Memcached y está lista para usarse.
UPDATING La instancia de Memcached está actualizando la configuración, como la política y la programación de mantenimiento.
DELETING Se está borrando la instancia de Memcached.
PERFORMING_MAINTENANCE La instancia de Memcached se encuentra en mantenimiento, p. ej., se encuentra en el lanzamiento del plano de datos.
MEMCACHE_VERSION_UPGRADING La instancia de Memcached está actualizando la versión del motor de Memcached.

Mensaje de la instancia

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

enum (Code)

Es un código que corresponde a un tipo de mensaje para el usuario.
message

string

Es el mensaje en la instancia de memcached que se expondrá a los usuarios.

Code

Enums
CODE_UNSPECIFIED No se estableció 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 salida. Es la hora en la que se creó la política.

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. Indica cuándo se actualizó la política.

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

string

Descripción del objetivo de esta política. Los métodos Create/Update muestran INVALID_ARGUMENT si la longitud es superior a 512.
weeklyMaintenanceWindow[]

object (WeeklyMaintenanceWindow)

Obligatorio. Período de mantenimiento que se aplica a los recursos cubiertos por esta política. Mínimo 1. Para la versión actual, se espera que la cantidad máxima de weekly_maintenance_windows sea uno.

WeeklyMaintenanceWindow

Es el período 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 en un día específico de la semana.
startTime

object (TimeOfDay)

Obligatorio. Hora de inicio del período en UTC.
duration

string (Duration format)

Obligatorio. Es la duración del período.

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".

MaintenanceSchedule

Próximo programa de mantenimiento.

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

string (Timestamp format)

Solo salida. La hora de inicio de cualquier próximo mantenimiento programado de esta 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".
endTime

string (Timestamp format)

Solo salida. La hora de finalización de cualquier próximo mantenimiento programado para esta 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".
scheduleDeadlineTime

string (Timestamp format)

Solo salida. La fecha límite de la hora de inicio del programa de mantenimiento, incluida la reprogramación.

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

Métodos

applyParameters

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

create

 Crea una instancia nueva en una ubicación determinada.

delete

 Borra una sola instancia.

get

 Obtiene los detalles de una sola instancia.

list

 Enumera instancias en una ubicación determinada.

patch

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

rescheduleMaintenance

 Reprograma el próximo evento de mantenimiento.

updateParameters

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

upgrade

 Actualiza la instancia de Memcache a una versión más reciente del motor de Memcached que se especifica en la solicitud.