REST Resource: projects.locations.instances

Recurso: instância

Uma instância do Memorystore para 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,
  "maintenancePolicy": {
    object (MaintenancePolicy)
  },
  "maintenanceSchedule": {
    object (MaintenanceSchedule)
  },
  "reservedIpRangeId": [
    string
  ]
}
Campos
name

string

Obrigatório. Nome exclusivo do recurso neste escopo, incluindo projeto e local usando o formulário: projects/{projectId}/locations/{locationId}/instances/{instanceId}

Observação: as instâncias do Memcached são gerenciadas e endereçadas no nível regional. Portanto, locationId se refere a uma região do Google Cloud. No entanto, os usuários podem escolher em quais zonas os nós do Memcached serão provisionados em uma instância. Consulte o campo zones para mais detalhes.

displayName

string

Nome fornecido pelo usuário para a instância, usado apenas para fins de exibição. Não pode ter mais de 80 caracteres.

labels

map (key: string, value: string)

Rótulos de recursos para representar metadados fornecidos por usuários Consulte a documentação da nuvem sobre rótulos para mais detalhes. https://cloud.google.com/compute/docs/labeling-resources

Um objeto com 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á conectada. Se não for especificada, a rede default será usada.

zones[]

string

Zonas em que os nós do Memcached precisam ser provisionados. Os nós do Memcached serão distribuídos igualmente entre essas zonas. Se não for fornecido, o serviço criará nós em todas as zonas da região para a 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 fornecido, a versão mais recente compatível será usada. No momento, a versão principal compatível mais recente é MEMCACHE_1_5. A versão secundária será determinada automaticamente pelo nosso sistema com base na versão secundária compatível mais recente.

parameters

object (MemcacheParameters)

Parâmetros definidos pelo usuário para aplicar ao processo do Memcache em cada nó.

memcacheNodes[]

object (Node)

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

createTime

string (Timestamp format)

Apenas saída. Horário em que a instância foi criada.

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. A hora em que a instância foi atualizada.

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

state

enum (State)

Apenas saída. O estado dessa 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 na MemcacheVersion de entrada. O formato completo da versão será "memcached-1.5.16".

instanceMessages[]

object (InstanceMessage)

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

discoveryEndpoint

string

Apenas saída. Endpoint da API Discovery.

maintenancePolicy

object (MaintenancePolicy)

A política de manutenção da instância. Se não for informado, o evento de manutenção será executado com base na programação de lançamento interno do Memorystore.

maintenanceSchedule

object (MaintenanceSchedule)

Apenas saída. A programação de manutenção foi publicada.

reservedIpRangeId[]

string

Opcional. Contém o ID dos intervalos de endereços IP alocados associados à conexão de acesso a serviços particulares, por exemplo, "test-default" associada ao intervalo de IPs 10.0.0.0/29.

NodeConfig

Configuração para 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 compatíveis com nosso serviço.

Enums
MEMCACHE_VERSION_UNSPECIFIED A versão do Memcache não foi especificada pelo cliente
MEMCACHE_1_5 Memcached versão 1.5.
MEMCACHE_1_6_15 Memcached versão 1.6.15.

MemcacheParameters

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

string

Apenas saída. O código exclusivo associado a esse conjunto de parâmetros. Os usuários podem usar esse ID para determinar se os parâmetros associados à instância são diferentes dos parâmetros associados aos nós. Uma discrepância entre os IDs dos parâmetros pode informar aos usuários que eles precisam agir para aplicar os parâmetros aos nós.

params

map (key: string, value: string)

Conjunto de parâmetros definido pelo usuário para uso no processo do memcached.

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

Representação JSON
{
  "nodeId": string,
  "zone": string,
  "state": enum (State),
  "host": string,
  "port": integer,
  "parameters": {
    object (MemcacheParameters)
  },
  "memcacheVersion": enum (MemcacheVersion),
  "memcacheFullVersion": string
}
Campos
nodeId

string

Apenas saída. Identificador do nó do Memcached. O código do nó não inclui projeto ou local, como o nome da instância do Memcached.

zone

string

Apenas saída. Local (zona do GCP) para o nó do Memcached.

state

enum (State)

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

host

string

Apenas saída. Nome do host ou endereço IP do nó do Memcached usado pelos clientes para se conectar ao servidor do 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 usuário atualmente aplicados ao nó.

memcacheVersion

enum (MemcacheVersion)

Apenas saída. Versão principal do servidor do Memcache 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

Estados diferentes de um nó do Memcached.

Enums
STATE_UNSPECIFIED O estado do nó não está definido.
CREATING O nó está sendo criado.
READY O nó foi criado e está pronto para ser usado.
DELETING O nó está sendo excluído.
UPDATING O nó está sendo atualizado.

State

Estados diferentes de uma instância do Memcached.

Enums
STATE_UNSPECIFIED Estado não definido.
CREATING A instância do Memcached está sendo criada.
READY A instância do Memcached foi criada e está pronta para ser usada.
UPDATING A instância do Memcache está atualizando a configuração, como a política de manutenção e a programação.
DELETING A instância do Memcached está sendo excluída.
PERFORMING_MAINTENANCE A instância do Memcached está passando pela manutenção, por exemplo, o lançamento do plano de dados.
MEMCACHE_VERSION_UPGRADING A instância do Memcache está passando pelo upgrade da versão do mecanismo Memcache.

InstanceMessage

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

enum (Code)

Um código que corresponde a um tipo de mensagem voltada para o usuário.

message

string

Mensagem na instância do memcached que será exposta aos usuários.

País

Enums
CODE_UNSPECIFIED Código da mensagem não definido.
ZONE_DISTRIBUTION_UNBALANCED Os nós do Memcached são distribuídos de maneira uniforme.

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.

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. A hora em que a política foi atualizada.

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

description

string

Descrição da finalidade desta política. Os métodos Create/Update retornam INVALID_MCC se o tamanho for maior que 512.

weeklyMaintenanceWindow[]

object (WeeklyMaintenanceWindow)

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

WeeklyMaintenanceWindow

Janela de tempo especificada para operações semanais.

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

enum (DayOfWeek)

Obrigatório. Permite definir a programação que executa o dia especificado da semana.

startTime

object (TimeOfDay)

Obrigatório. Horário de início da janela em UTC.

duration

string (Duration format)

Obrigatório. Duração da janela.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

MaintenanceSchedule

Programação de manutenção futura.

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

string (Timestamp format)

Apenas saída. O horário de início de qualquer manutenção agendada futura dessa 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".

endTime

string (Timestamp format)

Apenas saída. O horário de término de qualquer manutenção programada futura para esta 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".

scheduleDeadlineTime

string (Timestamp format)

Apenas saída. O prazo a que o horário de início da programação de manutenção não pode ser ultrapassado, incluindo o reagendamento.

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

Métodos

applyParameters

ApplyParameters reinicia o conjunto de nós especificados para atualizá-los ao conjunto atual de parâmetros da instância do Memcached.

create

Cria uma nova instância em um determinado local.

delete

Exclui uma única instância.

get

Recebe detalhes de uma única instância.

list

Lista as instâncias em um determinado local.

patch

Atualiza uma instância atual em um determinado projeto e local.

rescheduleMaintenance

Reagenda o evento de manutenção futura.

updateParameters

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

upgrade

Faz upgrade da instância do Memcache para uma versão mais recente do mecanismo memcached especificada na solicitação.