REST Resource: projects.locations.instances

Recurso: instância

Uma instância do Memorystore for Memcached

Representação 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

Obrigatório. Nome exclusivo do recurso neste âmbito, incluindo o projeto e a localização, no formato: projects/{projectId}/locations/{locationId}/instances/{instanceId}

Nota: as instâncias do Memcached são geridas e abordadas ao nível regional, pelo que locationId aqui se refere a uma região do Google Cloud. No entanto, os utilizadores podem escolher em que zonas os nós do Memcached devem ser aprovisionados numa instância. Consulte o campo zones para ver mais detalhes.
displayName

string

Nome fornecido pelo utilizador para a instância, que é usado apenas para fins de apresentação. Não pode ter mais de 80 carateres.
labels

map (key: string, value: string)

Etiquetas de recursos para representar metadados fornecidos pelos utilizadores. Consulte a documentação da nuvem sobre etiquetas para obter mais detalhes. https://cloud.google.com/compute/docs/labeling-resources

Um objeto que contém uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
authorizedNetwork

string

O nome completo da rede do Google Compute Engine à qual a instância está ligada. Se não for especificado, é usada a rede default.
zones[]

string

Zonas nas quais os nós do Memcached devem ser aprovisionados. Os nós do Memcached são distribuídos igualmente por estas zonas. Se não for fornecido, o serviço cria nós por predefinição em todas as zonas na região da instância.
nodeCount

integer

Obrigatório. Número de nós na instância do Memcached.
nodeConfig

object (NodeConfig)

Obrigatório. Configuração para nós do Memcached.
memcacheVersion

enum (MemcacheVersion)

A versão principal do software Memcached. Se não for indicado, é usada a versão suportada mais recente. Atualmente, a versão principal mais recente suportada é a MEMCACHE_1_5. A versão secundária é determinada automaticamente pelo nosso sistema com base na versão secundária compatível mais recente.
parameters

object (MemcacheParameters)

Parâmetros definidos pelo utilizador a aplicar ao processo memcached em cada nó.
memcacheNodes[]

object (Node)

Apenas saída. Lista de nós do Memcached. Consulte a mensagem Node para ver mais detalhes.
createTime

string (Timestamp format)

Apenas saída. A hora em que a instância foi criada.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". 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. A hora em que a instância foi atualizada.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". 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 desta instância do Memcached.
memcacheFullVersion

string

Apenas saída. A versão completa do servidor memcached em execução nesta instância. O sistema determina automaticamente a versão completa do memcached para uma instância com base no MemcacheVersion introduzido. O formato da versão completa é "memcached-1.5.16".
instanceMessages[]

object (InstanceMessage)

Lista de mensagens que descrevem o estado atual da instância do Memcached.
discoveryEndpoint

string

Apenas saída. Ponto final da API Discovery.
updateAvailable

boolean

Apenas saída. Devolve true se houver uma atualização pendente de aplicação
maintenancePolicy

object (MaintenancePolicy)

A política de manutenção da instância. Se não for indicado, o evento de manutenção é realizado com base no cronograma de implementação interno do Memorystore.
maintenanceSchedule

object (MaintenanceSchedule)

Apenas saída. Agendamento de manutenção publicado.
reservedIpRangeId[]

string

Opcional. Contém o ID dos intervalos de endereços IP atribuídos associados à ligação de acesso ao serviço privado, por exemplo, "test-default" associado ao intervalo de IP 10.0.0.0/29.
satisfiesPzs

boolean

Opcional. Apenas saída. Reservado para utilização futura.
satisfiesPzi

boolean

Opcional. Apenas saída. Reservado para utilização futura.

NodeConfig

Configuração de um nó do Memcached.

Representação JSON 
{
  "cpuCount": integer,
  "memorySizeMb": integer
}
Campos
cpuCount

integer

Obrigatório. Número de CPUs por nó do Memcached.
memorySizeMb

integer

Obrigatório. Tamanho da memória em MiB para cada nó do Memcached.

MemcacheVersion

Versões do Memcached suportadas pelo nosso serviço.

Enumerações
MEMCACHE_VERSION_UNSPECIFIED A versão do Memcache não é especificada pelo cliente
MEMCACHE_1_5 Versão 1.5 do Memcached.
MEMCACHE_1_6_15 Versão 1.6.15 do Memcached.

MemcacheParameters

Representação JSON 
{
  "id": string,
  "params": {
    string: string,
    ...
  }
}
Campos
id

string

Apenas saída. O ID exclusivo associado a este conjunto de parâmetros. Os utilizadores podem usar este ID para determinar se os parâmetros associados à instância diferem dos parâmetros associados aos nós. Uma discrepância entre os IDs dos parâmetros pode informar os utilizadores de que podem ter de tomar medidas para aplicar parâmetros nos nós.
params

map (key: string, value: string)

Conjunto de parâmetros definidos pelo utilizador para usar no processo memcached.

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

Nó

Representação 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

Apenas saída. Identificador do nó do Memcached. O ID do nó não inclui o projeto nem a localização, como o nome da instância do Memcached.
zone

string

Apenas saída. Localização (zona do GCP) do nó do Memcached.
state

enum (State)

Apenas saída. Estado atual do nó do Memcached.
host

string

Apenas saída. Nome do anfitrião ou endereço IP do nó Memcached usado pelos clientes para estabelecer ligação ao servidor Memcached neste nó.
port

integer

Apenas saída. O número da porta do servidor Memcached neste nó.
parameters

object (MemcacheParameters)

Parâmetros definidos pelo utilizador atualmente aplicados ao nó.
updateAvailable

boolean

Apenas saída. Devolve true se houver uma atualização pendente de aplicação
memcacheVersion

enum (MemcacheVersion)

Apenas saída. Versão principal do servidor memcached em execução neste nó, por exemplo, MEMCACHE_1_5
memcacheFullVersion

string

Apenas saída. A versão completa do servidor memcached em execução neste nó. Por exemplo: - memcached-1.5.16

Estado

Diferentes estados de um nó do Memcached.

Enumerações
STATE_UNSPECIFIED O estado do nó não está definido.
CREATING O nó está a ser criado.
READY O nó foi criado e está pronto a ser usado.
DELETING O nó está a ser eliminado.
UPDATING O nó está a ser atualizado.

Estado

Diferentes estados de uma instância do Memcached.

Enumerações
STATE_UNSPECIFIED Estado não definido.
CREATING A instância do Memcached está a ser criada.
READY A instância do Memcached foi criada e está pronta a ser usada.
UPDATING A instância do Memcached está a atualizar a configuração, como a política e a programação de manutenção.
DELETING A instância do Memcached está a ser eliminada.
PERFORMING_MAINTENANCE A instância do Memcached está a ser sujeita a manutenção, por exemplo, implementação do plano de dados.
MEMCACHE_VERSION_UPGRADING A instância do Memcached está a ser atualizada para a versão do motor do Memcached.

InstanceMessage

Representação JSON 
{
  "code": enum (Code),
  "message": string
}
Campos
code

enum (Code)

Um código que corresponde a um tipo de mensagem apresentada ao utilizador.
message

string

Mensagem na instância do memcached que vai ser exposta aos utilizadores.

Código

Enumerações
CODE_UNSPECIFIED O código da mensagem não foi definido.
ZONE_DISTRIBUTION_UNBALANCED Os nós do Memcached estão distribuídos de forma desigual.

MaintenancePolicy

Política de manutenção por instância.

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

string (Timestamp format)

Apenas saída. A hora em que a política foi criada.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". 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. A hora em que a política foi atualizada.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
description

string

Descrição da finalidade desta política. Os métodos de criação/atualização devolvem INVALID_ARGUMENT se o comprimento for superior a 512.
weeklyMaintenanceWindow[]

object (WeeklyMaintenanceWindow)

Obrigatório. Janela de manutenção que é aplicada aos recursos abrangidos por esta política. Mínimo de 1. Para a versão atual, o número máximo de weekly_maintenance_windows esperado é um.

WeeklyMaintenanceWindow

Período especificado para as operações semanais.

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

enum (DayOfWeek)

Obrigatório. Permite definir uma programação que é executada num dia especificado da semana.
startTime

object (TimeOfDay)

Obrigatório. Hora de início do período em UTC.
duration

string (Duration format)

Obrigatório. Duração do período.

Uma duração em segundos com até nove dígitos fracionários, que termina com "s". Exemplo: "3.5s".

MaintenanceSchedule

Agendamento de manutenção futura.

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

string (Timestamp format)

Apenas saída. A hora de início de qualquer manutenção agendada futura para esta instância.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". 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. A hora de fim de qualquer manutenção agendada futura para esta instância.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
scheduleDeadlineTime

string (Timestamp format)

Apenas saída. O prazo que a hora de início da programação de manutenção não pode ultrapassar, incluindo o reagendamento.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

Métodos

applyParameters

 ApplyParameters reinicia o conjunto de nós especificados para os atualizar para o conjunto atual de parâmetros da instância do Memcached.

applySoftwareUpdate

 Atualiza o software nos nós selecionados da instância.

create

 Cria uma nova instância numa determinada localização.

delete

 Elimina uma única instância.

get

 Recebe detalhes de uma única instância.

list

 Lista as instâncias numa determinada localização.

patch

 Atualiza uma instância existente num determinado projeto e localização.

rescheduleMaintenance

 Executa a fase de aplicação do verbo RescheduleMaintenance.

updateParameters

 Atualiza os parâmetros do Memcached definidos para uma instância existente.

upgrade

 Atualiza a instância do Memcache para uma versão mais recente do motor memcached especificada no pedido.