Recurso da REST: projects.locations.instances

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Recurso: instância

Uma instância do Redis do Google Cloud.

Representação JSON

{
  "name": string,
  "displayName": string,
  "labels": {
    string: string,
    ...
  },
  "locationId": string,
  "alternativeLocationId": string,
  "redisVersion": string,
  "reservedIpRange": string,
  "host": string,
  "port": number,
  "currentLocationId": string,
  "createTime": string,
  "state": enum(State),
  "statusMessage": string,
  "redisConfigs": {
    string: string,
    ...
  },
  "tier": enum(Tier),
  "memorySizeGb": number,
  "authorizedNetwork": string,
  "persistenceIamIdentity": 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 Redis são gerenciadas e tratadas regionalmente, de modo que "locationId" aqui se refere a uma região do GCP. No entanto, os usuários podem escolher em qual zona específica (ou coleção de zonas, para instâncias de zona cruzada) uma instância deve ser provisionada. Para saber mais detalhes, consulte os campos [locationId] e [alternativeLocationId].

displayName

string

Um nome para a instância arbitrário e opcional, fornecido por usuários.

labels

map (key: string, value: string)

Rótulos de recursos para representar metadados fornecidos por usuários

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

locationId

string

Opcional. A zona em que a instância será provisionada. Se a informação não for fornecida, o serviço escolherá uma zona para a instância. Para o nível STANDARD_HA, as instâncias serão criadas em duas zonas para proteção contra falhas zonais. Se [alternativeLocationId] também for fornecido, precisará ser diferente de [locationId].

alternativeLocationId

string

Opcional. Aplicável somente à camada STANDARD_HA, que protege a instância contra falhas zonais, provisionando-a em duas zonas. Se fornecido, precisa ser uma zona diferente da fornecida em [locationId].

redisVersion

string

Opcional. A versão do software Redis. Se não for fornecido, a versão mais recente compatível será usada. A atualização da versão realizará um upgrade/downgrade para a nova versão. Atualmente, os valores compatíveis são REDIS_3_2 para o Redis 3.2.

reservedIpRange

string

Opcional. O intervalo CIDR de endereços internos reservados para essa instância. Se não for fornecido, o serviço escolherá um bloco /29 não utilizado, por exemplo, 10.0.0.0/29 ou 192.168.0.0/29. Os intervalos precisam ser exclusivos e não se sobreporem às sub-redes existentes em uma rede autorizada.

host

string

Apenas saída. Nome do host ou endereço IP do ponto de extremidade do Redis exposto usado pelos clientes para se conectar ao serviço.

port

number

Apenas saída. O número da porta do ponto de extremidade do Redis exposto.

currentLocationId

string

Apenas saída. A zona atual em que o ponto de extremidade do Redis é colocado. Para instâncias do nível básico, será sempre a mesma zona que no [locationId] fornecido pelo usuário no momento da criação. Para instâncias de nível padrão, pode ser tanto [locationId] quanto [alternativeLocationId] e pode ser alterada após um evento de failover.

createTime

string (Timestamp format)

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

Um timestamp no formato UTC "Zulu" RFC3339 é precisamente medido em nanossegundos. Exemplo: "2014-10-02T15:01:23.045123456Z".

state

enum(State)

Apenas saída. O estado atual desta instância.

statusMessage

string

Apenas saída. Outras informações sobre o status atual desta instância, caso disponíveis.

redisConfigs

map (key: string, value: string)

Opcional. Parâmetros de configuração do Redis, de acordo com http://redis.io/topics/config. Atualmente, os únicos parâmetros compatíveis são:

  • maxmemory-policy
  • notify-keyspace-events

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

tier

enum (Tier)

Obrigatório. O nível de serviço da instância.

memorySizeGb

number

Obrigatório. O tamanho da memória do Redis, em GiB.

authorizedNetwork

string

Opcional. O nome completo da rede do Google Compute Engine à qual a instância está conectada. Se não for especificado, será usada a rede default.

persistenceIamIdentity

string

Apenas saída. Identidade do IAM usada pelas operações de importação/exportação para transferir dados para o/do GCS. O formato é "serviceAccount:". O valor pode mudar ao longo do tempo para uma determinada instância, portanto, é preciso verificá-lo antes de cada operação de importação/exportação.

Estado

Representa os diferentes estados de uma instância do Redis.

Enums
STATE_UNSPECIFIED Não definido
CREATING A instância do Redis está sendo criada.
READY A instância Redis foi criada e está totalmente utilizável.
UPDATING A configuração da instância do Redis está sendo atualizada. Determinados tipos de atualização podem fazer com que a instância fique inutilizável durante o processo de atualização
DELETING A instância do Redis está sendo excluída.
REPAIRING A instância do Redis está sendo reparada e pode estar inutilizável. Detalhes podem ser encontrados no campo statusMessage.
MAINTENANCE Esta instância do Redis está passando por um processo de manutenção.
IMPORTING A instância do Redis está importando dados (a disponibilidade pode ser afetada).

Nível

Níveis de serviço disponíveis para escolha

Enums
TIER_UNSPECIFIED Não definido
BASIC Nível BASIC: instância independente
STANDARD_HA Nível STANDARD_HA: instâncias principais altamente disponíveis/instâncias de réplica

Métodos

create

Cria uma instância do Redis com base no nível especificado e no tamanho da memória.

delete

Exclui uma instância específica do Redis.

get

Tem acesso aos detalhes de uma instância específica do Redis.

list

Lista todas as instâncias do Redis pertencentes a um projeto no local especificado (região) ou em todos os locais.

patch

Atualiza os metadados e as configurações de uma instância específica do Redis.