MCP Tools Reference: memorystore.googleapis.com

Ferramenta: get_instance

Receba informações detalhadas sobre uma instância do Memorystore for Valkey.

O exemplo a seguir demonstra como usar curl para invocar a ferramenta get_instance MCP.

Solicitação curl 
                  
curl --location 'https://memorystore.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "get_instance",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Esquema de entrada

Mensagem de solicitação para GetInstance.

GetInstanceRequest

Representação JSON 
{
  "name": string
}
Campos
name

string

Obrigatório. O nome da instância a ser recuperada. Formato: projects/{project}/locations/{location}/instances/{instance}

Esquema de saída

Uma instância do Memorystore.

Instância

Representação JSON 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "state": enum (State),
  "stateInfo": {
    object (StateInfo)
  },
  "uid": string,
  "authorizationMode": enum (AuthorizationMode),
  "transitEncryptionMode": enum (TransitEncryptionMode),
  "shardCount": integer,
  "discoveryEndpoints": [
    {
      object (DiscoveryEndpoint)
    }
  ],
  "nodeType": enum (NodeType),
  "persistenceConfig": {
    object (PersistenceConfig)
  },
  "engineVersion": string,
  "engineConfigs": {
    string: string,
    ...
  },
  "nodeConfig": {
    object (NodeConfig)
  },
  "zoneDistributionConfig": {
    object (ZoneDistributionConfig)
  },
  "pscAutoConnections": [
    {
      object (PscAutoConnection)
    }
  ],
  "pscAttachmentDetails": [
    {
      object (PscAttachmentDetail)
    }
  ],
  "endpoints": [
    {
      object (InstanceEndpoint)
    }
  ],
  "mode": enum (Mode),
  "maintenancePolicy": {
    object (MaintenancePolicy)
  },
  "maintenanceSchedule": {
    object (MaintenanceSchedule)
  },
  "crossInstanceReplicationConfig": {
    object (CrossInstanceReplicationConfig)
  },
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "automatedBackupConfig": {
    object (AutomatedBackupConfig)
  },
  "availableMaintenanceVersions": [
    string
  ],
  "allowFewerZonesDeployment": boolean,
  "migrationConfig": {
    object (MigrationConfig)
  },

  // Union field import_sources can be only one of the following:
  "gcsSource": {
    object (GcsBackupSource)
  },
  "managedBackupSource": {
    object (ManagedBackupSource)
  }
  // End of list of possible types for union field import_sources.

  // Union field _replica_count can be only one of the following:
  "replicaCount": integer
  // End of list of possible types for union field _replica_count.

  // Union field _deletion_protection_enabled can be only one of the following:
  "deletionProtectionEnabled": boolean
  // End of list of possible types for union field _deletion_protection_enabled.

  // Union field _simulate_maintenance_event can be only one of the following:
  "simulateMaintenanceEvent": boolean
  // End of list of possible types for union field _simulate_maintenance_event.

  // Union field _ondemand_maintenance can be only one of the following:
  "ondemandMaintenance": boolean
  // End of list of possible types for union field _ondemand_maintenance.

  // Union field _satisfies_pzs can be only one of the following:
  "satisfiesPzs": boolean
  // End of list of possible types for union field _satisfies_pzs.

  // Union field _satisfies_pzi can be only one of the following:
  "satisfiesPzi": boolean
  // End of list of possible types for union field _satisfies_pzi.

  // Union field _async_instance_endpoints_deletion_enabled can be only one of
  // the following:
  "asyncInstanceEndpointsDeletionEnabled": boolean
  // End of list of possible types for union field
  // _async_instance_endpoints_deletion_enabled.

  // Union field _kms_key can be only one of the following:
  "kmsKey": string
  // End of list of possible types for union field _kms_key.

  // Union field _backup_collection can be only one of the following:
  "backupCollection": string
  // End of list of possible types for union field _backup_collection.

  // Union field _maintenance_version can be only one of the following:
  "maintenanceVersion": string
  // End of list of possible types for union field _maintenance_version.

  // Union field _effective_maintenance_version can be only one of the following:
  "effectiveMaintenanceVersion": string
  // End of list of possible types for union field
  // _effective_maintenance_version.

  // Union field _server_ca_mode can be only one of the following:
  "serverCaMode": enum (ServerCaMode)
  // End of list of possible types for union field _server_ca_mode.

  // Union field _server_ca_pool can be only one of the following:
  "serverCaPool": string
  // End of list of possible types for union field _server_ca_pool.

  // Union field _rotate_server_certificate can be only one of the following:
  "rotateServerCertificate": boolean
  // End of list of possible types for union field _rotate_server_certificate.

  // Union field _acl_policy can be only one of the following:
  "aclPolicy": string
  // End of list of possible types for union field _acl_policy.

  // Union field _acl_policy_in_sync can be only one of the following:
  "aclPolicyInSync": boolean
  // End of list of possible types for union field _acl_policy_in_sync.
}
Campos
name

string

Identificador. Nome exclusivo da instância. Formato: projects/{project}/locations/{location}/instances/{instance}
createTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora de criação da instância.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. 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. Carimbo de data/hora da última atualização da instância.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Opcional. Rótulos para representar metadados fornecidos pelo usuário.

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

enum (State)

Apenas saída. Estado atual da instância.
stateInfo

object (StateInfo)

Apenas saída. Informações extras sobre o estado da instância.
uid

string

Apenas saída. Identificador exclusivo atribuído pelo sistema para a instância.
authorizationMode

enum (AuthorizationMode)

Opcional. Imutável. Modo de autorização da instância.
transitEncryptionMode

enum (TransitEncryptionMode)

Opcional. Imutável. Modo de criptografia em trânsito da instância.
shardCount

integer

Opcional. Número de fragmentos para a instância.
discoveryEndpoints[]
(deprecated)

object (DiscoveryEndpoint)

Apenas saída. Descontinuado: o parâmetro "discovery_endpoints" foi descontinuado. Como resultado, ele não será preenchido se as conexões forem criadas usando o parâmetro "endpoints". Em vez desse parâmetro, para descoberta, use "endpoints.connections.pscConnection" e "endpoints.connections.pscAutoConnection" com "connectionType CONNECTION_TYPE_DISCOVERY".
nodeType

enum (NodeType)

Opcional. Tipo de máquina para nós individuais da instância.
persistenceConfig

object (PersistenceConfig)

Opcional. Configuração de persistência da instância.
engineVersion

string

Opcional. Versão do mecanismo da instância.
engineConfigs

map (key: string, value: string)

Opcional. Configurações de mecanismo fornecidas pelo usuário para a instância.

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

object (NodeConfig)

Apenas saída. Configuração de nós individuais da instância.
zoneDistributionConfig

object (ZoneDistributionConfig)

Opcional. Imutável. Configuração de distribuição de zona da instância para alocação de nós.
pscAutoConnections[]
(deprecated)

object (PscAutoConnection)

Opcional. Imutável. Descontinuado: use o valor endpoints.connections.psc_auto_connection.
pscAttachmentDetails[]

object (PscAttachmentDetail)

Apenas saída. Detalhes do anexo de serviço para configurar conexões do PSC.
endpoints[]

object (InstanceEndpoint)

Opcional. Endpoints da instância.
mode

enum (Mode)

Opcional. A configuração de modo da instância.
maintenancePolicy

object (MaintenancePolicy)

Opcional. A política de manutenção da instância. Se não for fornecido, o evento de manutenção será realizado com base no cronograma de lançamento interno do Memorystore.
maintenanceSchedule

object (MaintenanceSchedule)

Apenas saída. Cronograma de manutenção publicado.
crossInstanceReplicationConfig

object (CrossInstanceReplicationConfig)

Opcional. A configuração para replicação entre instâncias.
encryptionInfo

object (EncryptionInfo)

Apenas saída. Informações de criptografia dos dados em repouso do cluster.
automatedBackupConfig

object (AutomatedBackupConfig)

Opcional. A configuração de backup automatizado da instância.
availableMaintenanceVersions[]

string

Apenas saída. Esse campo é usado para determinar as versões de manutenção disponíveis para a atualização de autoatendimento.
allowFewerZonesDeployment
(deprecated)

boolean

Opcional. Imutável. Descontinuado, não use.
migrationConfig

object (MigrationConfig)

Apenas saída. Configuração de migração para a instância.
Campo de união import_sources. A origem da importação. import_sources pode ser apenas de um dos tipos a seguir:
gcsSource

object (GcsBackupSource)

Opcional. Imutável. Backups armazenados em buckets do Cloud Storage. Os buckets do Cloud Storage precisam estar na mesma região que as instâncias. A permissão de leitura é necessária para importar dos objetos do Cloud Storage fornecidos.
managedBackupSource

object (ManagedBackupSource)

Opcional. Imutável. Backups gerados e gerenciados pelo serviço do Memorystore.

Campo de união _replica_count.

_replica_count pode ser apenas de um dos tipos a seguir:
replicaCount

integer

Opcional. Número de nós de réplica por fragmento. Se omitido, o padrão será 0 réplicas.

Campo de união _deletion_protection_enabled.

_deletion_protection_enabled pode ser apenas de um dos tipos a seguir:
deletionProtectionEnabled

boolean

Opcional. Se definido como verdadeiro, a exclusão da instância vai falhar.

Campo de união _simulate_maintenance_event.

_simulate_maintenance_event pode ser apenas de um dos tipos a seguir:
simulateMaintenanceEvent

boolean

Opcional. Somente entrada. Simula um evento de manutenção.

Campo de união _ondemand_maintenance.

_ondemand_maintenance pode ser apenas de um dos tipos a seguir:
ondemandMaintenance
(deprecated)

boolean

Opcional. Somente entrada. Manutenção sob demanda para a instância.

Campo de união _satisfies_pzs.

_satisfies_pzs pode ser apenas de um dos tipos a seguir:
satisfiesPzs

boolean

Opcional. Apenas saída. Reservado para uso futuro.

Campo de união _satisfies_pzi.

_satisfies_pzi pode ser apenas de um dos tipos a seguir:
satisfiesPzi

boolean

Opcional. Apenas saída. Reservado para uso futuro.

Campo de união _async_instance_endpoints_deletion_enabled.

_async_instance_endpoints_deletion_enabled pode ser apenas de um dos tipos a seguir:
asyncInstanceEndpointsDeletionEnabled

boolean

Opcional. Se for verdadeiro, os endpoints de instância criados e registrados pelos clientes poderão ser excluídos de forma assíncrona. Ou seja, um endpoint de instância pode ser cancelado antes que as regras de encaminhamento no endpoint de instância sejam excluídas.

Campo de união _kms_key.

_kms_key pode ser apenas de um dos tipos a seguir:
kmsKey

string

Opcional. A chave do KMS usada para criptografar os dados em repouso do cluster.

Campo de união _backup_collection.

_backup_collection pode ser apenas de um dos tipos a seguir:
backupCollection

string

Apenas saída. O nome completo do recurso da coleção de backup. Exemplo: projects/{project}/locations/{location}/backupCollections/{collection}

Campo de união _maintenance_version.

_maintenance_version pode ser apenas de um dos tipos a seguir:
maintenanceVersion

string

Opcional. Esse campo pode ser usado para acionar a atualização de autoatendimento e indicar a versão de manutenção desejada. A entrada desse campo pode ser determinada pelo campo "available_maintenance_versions".

Campo de união _effective_maintenance_version.

_effective_maintenance_version pode ser apenas de um dos tipos a seguir:
effectiveMaintenanceVersion

string

Apenas saída. Esse campo representa a versão de manutenção real da instância.

Campo de união _server_ca_mode.

_server_ca_mode pode ser apenas de um dos tipos a seguir:
serverCaMode

enum (ServerCaMode)

Opcional. Imutável. O modo de AC do servidor para a instância.

Campo de união _server_ca_pool.

_server_ca_pool pode ser apenas de um dos tipos a seguir:
serverCaPool

string

Opcional. Imutável. O pool de ACs gerenciado pelo cliente para a instância. Aplicável apenas se o modo da AC do servidor for CUSTOMER_MANAGED_CAS_CA. Formato: "projects/{project}/locations/{region}/caPools/{ca_pool}".

Campo de união _rotate_server_certificate.

_rotate_server_certificate pode ser apenas de um dos tipos a seguir:
rotateServerCertificate

boolean

Opcional. Somente entrada. Troque os certificados do servidor.

Campo de união _acl_policy.

_acl_policy pode ser apenas de um dos tipos a seguir:
aclPolicy

string

Opcional. A política de ACL da instância. Formato: projects/{project}/locations/{location}/aclPolicies/{acl_policy}

Campo de união _acl_policy_in_sync.

_acl_policy_in_sync pode ser apenas de um dos tipos a seguir:
aclPolicyInSync

boolean

Apenas saída. Se as regras de ACL aplicadas à instância estão sincronizadas com as regras de política de ACL mais recentes. Esse campo só é aplicável se a política de ACL estiver definida para a instância.

GcsBackupSource

Representação JSON 
{
  "uris": [
    string
  ]
}
Campos
uris[]

string

Opcional. Exemplo: gs://bucket1/object1, gs://bucket2/folder2/object2

ManagedBackupSource

Representação JSON 
{
  "backup": string
}
Campos
backup

string

Opcional. Exemplo: //memorystore.googleapis.com/projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup}. Uma versão mais curta (sem o prefixo) do nome do backup também é aceita, como projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup_id}. Nesse caso, presume-se que o backup esteja em memorystore.googleapis.com.

Carimbo de data/hora

Representação JSON 
{
  "seconds": string,
  "nanos": integer
}
Campos
seconds

string (int64 format)

Representa os segundos do horário UTC desde a época Unix 1970-01-01T00:00:00Z. Precisa estar entre -62135596800 e 253402300799 (o que corresponde a 0001-01-01T00:00:00Z a 9999-12-31T23:59:59Z).
nanos

integer

Frações não negativas de um segundo com resolução de nanossegundos. Esse campo é a parte de nanossegundos da duração, não uma alternativa aos segundos. Os valores de segundos negativos com frações ainda precisam ter valores em nanossegundos não negativos que representam períodos posteriores. O valor precisa estar entre 0 e 999.999.999 (inclusive).

LabelsEntry

Representação JSON 
{
  "key": string,
  "value": string
}
Campos
key

string
value

string

StateInfo

Representação JSON 
{

  // Union field info can be only one of the following:
  "updateInfo": {
    object (UpdateInfo)
  }
  // End of list of possible types for union field info.
}
Campos

Campo de união info.

info pode ser apenas de um dos tipos a seguir:
updateInfo

object (UpdateInfo)

Apenas saída. Descreve a atualização em andamento quando o estado da instância é UPDATING.

UpdateInfo

Representação JSON 
{

  // Union field _target_shard_count can be only one of the following:
  "targetShardCount": integer
  // End of list of possible types for union field _target_shard_count.

  // Union field _target_replica_count can be only one of the following:
  "targetReplicaCount": integer
  // End of list of possible types for union field _target_replica_count.

  // Union field _target_engine_version can be only one of the following:
  "targetEngineVersion": string
  // End of list of possible types for union field _target_engine_version.

  // Union field _target_node_type can be only one of the following:
  "targetNodeType": enum (NodeType)
  // End of list of possible types for union field _target_node_type.
}
Campos

Campo de união _target_shard_count.

_target_shard_count pode ser apenas de um dos tipos a seguir:
targetShardCount

integer

Apenas saída. Número de destino de fragmentos para a instância.

Campo de união _target_replica_count.

_target_replica_count pode ser apenas de um dos tipos a seguir:
targetReplicaCount

integer

Apenas saída. Número de destino de nós de réplica por fragmento para a instância.

Campo de união _target_engine_version.

_target_engine_version pode ser apenas de um dos tipos a seguir:
targetEngineVersion

string

Apenas saída. Versão do mecanismo de destino para a instância.

Campo de união _target_node_type.

_target_node_type pode ser apenas de um dos tipos a seguir:
targetNodeType

enum (NodeType)

Apenas saída. Tipo de nó de destino para a instância.

DiscoveryEndpoint

Representação JSON 
{
  "address": string,
  "port": integer,
  "network": string
}
Campos
address

string

Apenas saída. Endereço IP do endpoint exposto a que os clientes se conectam.
port

integer

Apenas saída. O número da porta do endpoint exposto.
network

string

Apenas saída. A rede em que o endereço IP do endpoint de descoberta será reservado, no formato projects/{network_project}/global/networks/{network_id}.

PersistenceConfig

Representação JSON 
{
  "mode": enum (PersistenceMode),
  "rdbConfig": {
    object (RDBConfig)
  },
  "aofConfig": {
    object (AOFConfig)
  }
}
Campos
mode

enum (PersistenceMode)

Opcional. Modo de persistência atual.
rdbConfig

object (RDBConfig)

Opcional. Configuração do RDB. Esse campo será ignorado se o modo não for RDB.
aofConfig

object (AOFConfig)

Opcional. Configuração de AOF. Esse campo será ignorado se o modo não for AOF.

RDBConfig

Representação JSON 
{
  "rdbSnapshotPeriod": enum (SnapshotPeriod),
  "rdbSnapshotStartTime": string
}
Campos
rdbSnapshotPeriod

enum (SnapshotPeriod)

Opcional. Período entre snapshots do RDB.
rdbSnapshotStartTime

string (Timestamp format)

Opcional. Hora em que o primeiro snapshot foi/será tentado e a que snapshots futuros serão alinhados. Se não for fornecido, o horário atual será usado.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

AOFConfig

Representação JSON 
{
  "appendFsync": enum (AppendFsync)
}
Campos
appendFsync

enum (AppendFsync)

Opcional. O modo fsync.

EngineConfigsEntry

Representação JSON 
{
  "key": string,
  "value": string
}
Campos
key

string
value

string

NodeConfig

Representação JSON 
{
  "sizeGb": number
}
Campos
sizeGb

number

Apenas saída. Tamanho da memória em GB do nó.

ZoneDistributionConfig

Representação JSON 
{
  "zone": string,
  "mode": enum (ZoneDistributionMode)
}
Campos
zone

string

Opcional. Define a zona em que todos os recursos serão alocados com o modo SINGLE_ZONE. Ignorado no modo MULTI_ZONE.
mode

enum (ZoneDistributionMode)

Opcional. Modo de distribuição de zona atual. O padrão é MULTI_ZONE.

PscAutoConnection

Representação JSON 
{
  "pscConnectionId": string,
  "ipAddress": string,
  "forwardingRule": string,
  "projectId": string,
  "network": string,
  "serviceAttachment": string,
  "pscConnectionStatus": enum (PscConnectionStatus),
  "connectionType": enum (ConnectionType),

  // Union field ports can be only one of the following:
  "port": integer
  // End of list of possible types for union field ports.
}
Campos
pscConnectionId

string

Apenas saída. O ID de conexão do PSC da regra de encaminhamento conectada ao anexo de serviço.
ipAddress

string

Apenas saída. O IP alocado na rede do consumidor para a regra de encaminhamento do PSC.
forwardingRule

string

Apenas saída. O URI da regra de encaminhamento do lado do consumidor. Formato: projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}
projectId

string

Obrigatório. O project_id do consumidor em que as conexões PSC são estabelecidas. Precisa ser o mesmo project_id em que a instância está sendo criada.
network

string

Obrigatório. A rede em que os endpoints do PSC são criados, no formato projects/{project_id}/global/networks/{network_id}.
serviceAttachment

string

Apenas saída. O anexo de serviço que é o destino da conexão PSC, no formato projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}.
pscConnectionStatus

enum (PscConnectionStatus)

Apenas saída. O status da conexão do PSC: se uma conexão existe e está ATIVA ou se ela não existe mais. Esse valor é atualizado periodicamente. Use as APIs do Private Service Connect para conferir o status mais recente.
connectionType

enum (ConnectionType)

Apenas saída. Tipo da conexão PSC.
Campo de união ports. Portas do endpoint exposto. ports pode ser apenas de um dos tipos a seguir:
port

integer

Opcional. A porta só será definida para o endpoint principal/leitor ou de descoberta.

PscAttachmentDetail

Representação JSON 
{
  "serviceAttachment": string,
  "connectionType": enum (ConnectionType)
}
Campos
serviceAttachment

string

Apenas saída. URI do anexo de serviço que sua PscConnection criada por você precisa usar como destino.
connectionType

enum (ConnectionType)

Apenas saída. Tipo de endpoint do PSC.

InstanceEndpoint

Representação JSON 
{
  "connections": [
    {
      object (ConnectionDetail)
    }
  ]
}
Campos
connections[]

object (ConnectionDetail)

Opcional. Um grupo de conexões do PSC. Elas são criadas na mesma rede VPC, uma para cada anexo de serviço no cluster.

ConnectionDetail

Representação JSON 
{

  // Union field connection can be only one of the following:
  "pscAutoConnection": {
    object (PscAutoConnection)
  },
  "pscConnection": {
    object (PscConnection)
  }
  // End of list of possible types for union field connection.
}
Campos
Campo de união connection. Uma conexão do PSC com uma instância pode ser criada pela automação de conectividade do serviço (conexão automática) durante a criação do cluster ou pelo próprio cliente (conexão criada pelo usuário). connection pode ser apenas de um dos tipos a seguir:
pscAutoConnection

object (PscAutoConnection)

Imutável. Informações detalhadas de uma conexão do PSC criada pela automação de conectividade do serviço.
pscConnection

object (PscConnection)

Informações detalhadas de uma conexão PSC criada pelo usuário.

PscConnection

Representação JSON 
{
  "pscConnectionId": string,
  "ipAddress": string,
  "forwardingRule": string,
  "projectId": string,
  "network": string,
  "serviceAttachment": string,
  "pscConnectionStatus": enum (PscConnectionStatus),
  "connectionType": enum (ConnectionType),

  // Union field ports can be only one of the following:
  "port": integer
  // End of list of possible types for union field ports.
}
Campos
pscConnectionId

string

Obrigatório. O ID de conexão do PSC da regra de encaminhamento conectada ao anexo de serviço.
ipAddress

string

Obrigatório. O IP alocado na rede do consumidor para a regra de encaminhamento do PSC.
forwardingRule

string

Obrigatório. O URI da regra de encaminhamento do lado do consumidor. Formato: projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}
projectId

string

Apenas saída. O project_id do consumidor em que a regra de encaminhamento é criada.
network

string

Obrigatório. A rede do consumidor em que o endereço IP reside, no formato projects/{project_id}/global/networks/{network_id}.
serviceAttachment

string

Obrigatório. O anexo de serviço que é o destino da conexão PSC, no formato projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}.
pscConnectionStatus

enum (PscConnectionStatus)

Apenas saída. O status da conexão do PSC: se uma conexão existe e está ATIVA ou se ela não existe mais. Esse valor é atualizado periodicamente. Use as APIs do Private Service Connect para conferir o status mais recente.
connectionType

enum (ConnectionType)

Apenas saída. Tipo da conexão PSC.
Campo de união ports. Portas do endpoint exposto. ports pode ser apenas de um dos tipos a seguir:
port

integer

Opcional. A porta só será definida para o endpoint principal/leitor ou de descoberta.

MaintenancePolicy

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

string (Timestamp format)

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

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. 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. O horário em que a política foi atualizada.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
weeklyMaintenanceWindow[]

object (WeeklyMaintenanceWindow)

Opcional. Janela de manutenção aplicada aos recursos cobertos por esta política. Mínimo de 1. Na versão atual, o número máximo de weekly_window é um.

WeeklyMaintenanceWindow

Representação JSON 
{
  "day": enum (google.type.DayOfWeek),
  "startTime": {
    object (TimeOfDay)
  }
}
Campos
day

enum (google.type.DayOfWeek)

Opcional. Permite definir uma programação que é executada em um dia especificado da semana.
startTime

object (TimeOfDay)

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

TimeOfDay

Representação JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Campos
hours

integer

Horas de um dia no formato de 24 horas. Precisa ser maior ou igual a 0 e geralmente menor ou igual a 23. Uma API pode permitir o valor "24:00:00" para o horário de fechamento da empresa, por exemplo.
minutes

integer

Minutos de uma hora. Precisa ser maior ou igual a 0 e menor ou igual a 59.
seconds

integer

Segundos de um minuto. Precisa ser maior ou igual a 0 e normalmente menor ou igual a 59. Uma API pode permitir o valor 60 se permitir segundos bissextos.
nanos

integer

Frações de segundos, em nanossegundos. Precisa ser maior ou igual a 0 e menor ou igual a 999.999.999.

MaintenanceSchedule

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

string (Timestamp format)

Apenas saída. O horário de início de qualquer manutenção agendada futura dessa instância.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. 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. O horário de término de qualquer manutenção agendada futura dessa instância.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

CrossInstanceReplicationConfig

Representação JSON 
{
  "instanceRole": enum (InstanceRole),
  "primaryInstance": {
    object (RemoteInstance)
  },
  "secondaryInstances": [
    {
      object (RemoteInstance)
    }
  ],
  "updateTime": string,
  "membership": {
    object (Membership)
  }
}
Campos
instanceRole

enum (InstanceRole)

Obrigatório. A função da instância na replicação entre instâncias.
primaryInstance

object (RemoteInstance)

Opcional. Detalhes da instância principal usada como origem de replicação para esta instância secundária.

Esse campo só é definido para uma instância secundária.
secondaryInstances[]

object (RemoteInstance)

Opcional. Lista de instâncias secundárias que estão replicando desta instância principal.

Esse campo só é definido para uma instância principal.
updateTime

string (Timestamp format)

Apenas saída. A última vez que a configuração de replicação entre instâncias foi atualizada.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
membership

object (Membership)

Apenas saída. Uma visualização somente de saída de todas as instâncias de membros que participam da replicação entre instâncias. Essa visualização será fornecida por todas as instâncias de membro, independente da função da instância(primária ou secundária).

Uma instância principal pode fornecer informações sobre todas as instâncias secundárias que estão replicando dela. No entanto, uma instância secundária só conhece a instância principal de que está replicando. No entanto, para cenários em que a instância principal não está disponível(por exemplo, uma interrupção regional), uma solicitação Getinstance pode ser enviada para qualquer outra instância de membro, e esse campo vai listar todas as instâncias de membro que participam da replicação entre instâncias.

RemoteInstance

Representação JSON 
{
  "instance": string,
  "uid": string
}
Campos
instance

string

Opcional. O caminho completo do recurso da instância remota no formato: projects//locations//instances/
uid

string

Apenas saída. O identificador exclusivo da instância remota.

Associação

Representação JSON 
{
  "primaryInstance": {
    object (RemoteInstance)
  },
  "secondaryInstances": [
    {
      object (RemoteInstance)
    }
  ]
}
Campos
primaryInstance

object (RemoteInstance)

Apenas saída. A instância principal que atua como origem da replicação para as instâncias secundárias.
secondaryInstances[]

object (RemoteInstance)

Apenas saída. A lista de instâncias secundárias replicadas da instância principal.

EncryptionInfo

Representação JSON 
{
  "encryptionType": enum (Type),
  "kmsKeyVersions": [
    string
  ],
  "kmsKeyPrimaryState": enum (KmsKeyState),
  "lastUpdateTime": string
}
Campos
encryptionType

enum (Type)

Apenas saída. Tipo de criptografia.
kmsKeyVersions[]

string

Apenas saída. Versões de chaves do KMS que estão sendo usadas para proteger os dados em repouso.
kmsKeyPrimaryState

enum (KmsKeyState)

Apenas saída. O estado da versão principal da chave do KMS percebido pelo sistema. Esse campo não é preenchido em backups.
lastUpdateTime

string (Timestamp format)

Apenas saída. A hora mais recente em que as informações de criptografia foram atualizadas.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

AutomatedBackupConfig

Representação JSON 
{
  "automatedBackupMode": enum (AutomatedBackupMode),
  "retention": string,

  // Union field schedule can be only one of the following:
  "fixedFrequencySchedule": {
    object (FixedFrequencySchedule)
  }
  // End of list of possible types for union field schedule.
}
Campos
automatedBackupMode

enum (AutomatedBackupMode)

Opcional. O modo de backup automático. Se o modo estiver desativado, os outros campos serão ignorados.
retention

string (Duration format)

Opcional. Por quanto tempo manter os backups automatizados antes que eles sejam excluídos. O valor precisa estar entre 1 dia e 365 dias. Se não for especificado, o valor padrão será de 35 dias.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
Campo de união schedule. A programação de backups automatizados. schedule pode ser apenas de um dos tipos a seguir:
fixedFrequencySchedule

object (FixedFrequencySchedule)

Opcional. Acionar backups automatizados com uma frequência fixa.

FixedFrequencySchedule

Representação JSON 
{
  "startTime": {
    object (TimeOfDay)
  }
}
Campos
startTime

object (TimeOfDay)

Obrigatório. O horário de início de cada backup automatizado em UTC. Ele precisa ser definido para o início de uma hora. Este campo é obrigatório.

Duração

Representação JSON 
{
  "seconds": string,
  "nanos": integer
}
Campos
seconds

string (int64 format)

Segundos assinados do período. Precisa estar entre -315.576.000.000 e +315.576.000.000 (inclusive). Observação: esses limites são calculados da seguinte forma: 60 s/min * 60 min/h * 24 h/dia * 365,25 dias/ano * 10.000 anos
nanos

integer

Frações assinadas de um segundo com resolução de nanossegundos do período. Durações menores que um segundo são representadas com um campo seconds 0 e um campo nanos positivo ou negativo. Para durações de um segundo ou mais, um valor diferente de zero para o campo nanos precisa ter o mesmo sinal do campo seconds. Precisa estar entre -999.999.999 e +999.999.999 (inclusive).

MigrationConfig

Representação JSON 
{
  "state": enum (State),
  "forceFinishMigration": boolean,

  // Union field source can be only one of the following:
  "selfManagedSource": {
    object (SelfManagedSource)
  }
  // End of list of possible types for union field source.
}
Campos
state

enum (State)

Apenas saída. Estado da migração da instância.
forceFinishMigration

boolean

Apenas saída. Representa uma flag booleana para forçar a finalização da migração sem validação de recuperação de atraso de compensação entre a origem e o destino antes de interromper a replicação.
Campo de união source. Detalhes sobre a origem da migração. source pode ser apenas de um dos tipos a seguir:
selfManagedSource

object (SelfManagedSource)

Apenas saída. Configuração para migrar de uma instância autogerenciada do Valkey/Redis

SelfManagedSource

Representação JSON 
{
  "ipAddress": string,
  "port": integer,
  "networkAttachment": string
}
Campos
ipAddress

string

Obrigatório. O endereço IP da instância de origem. Esse endereço IP precisa ser estável e acessível pela instância do Memorystore durante todo o processo de migração.
port

integer

Obrigatório. A porta da instância de origem. Essa porta precisa ser estável e acessível pela instância do Memorystore durante todo o processo de migração.
networkAttachment

string

Obrigatório. O nome do recurso do anexo de rede do Private Service Connect usado para estabelecer conectividade com a instância de origem. Esse anexo de rede tem os seguintes requisitos: 1. Precisa estar no mesmo projeto que a instância do Memorystore. 2. Ele precisa estar na mesma região que a instância do Memorystore. 3. A sub-rede anexada ao anexo de rede precisa estar na mesma rede VPC que os nós da instância de origem.

Formato: projects/{project}/regions/{region}/networkAttachments/{network_attachment}

Anotações de ferramentas

Dica destrutiva: ❌ | Dica idempotente: ✅ | Dica somente leitura: ✅ | Dica de mundo aberto: ❌