REST Resource: projects.locations.instances

Recurso: instância

Uma instância do Memorystore.

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)
  },
  "automatedBackupConfig": {
    object (AutomatedBackupConfig)
  },

  // 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.
  "replicaCount": integer,
  "deletionProtectionEnabled": boolean,
  "ondemandMaintenance": boolean,
  "asyncInstanceEndpointsDeletionEnabled": boolean,
  "backupCollection": string
}
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 RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Deslocamentos diferentes de "Z" 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 RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Deslocamentos diferentes de "Z" 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. Outras informações 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 da instância.

discoveryEndpoints[]
(deprecated)

object (DiscoveryEndpoint)

Apenas saída. Descontinuado: use os valores endpoints.connections.psc_auto_connection ou endpoints.connections.psc_connection.

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 do 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 da distribuição de zonas da instância para a 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 as 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 na programação de lançamento interno do Memorystore.

maintenanceSchedule

object (MaintenanceSchedule)

Apenas saída. Programação de manutenção publicada.

crossInstanceReplicationConfig

object (CrossInstanceReplicationConfig)

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

automatedBackupConfig

object (AutomatedBackupConfig)

Opcional. A configuração de backup automático da 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 das instâncias. É necessária a permissão de leitura para importar dos objetos do Cloud Storage fornecidos.

managedBackupSource

object (ManagedBackupSource)

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

replicaCount

integer

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

deletionProtectionEnabled

boolean

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

ondemandMaintenance

boolean

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

asyncInstanceEndpointsDeletionEnabled

boolean

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

backupCollection

string

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

GcsBackupSource

Backups armazenados em buckets do Cloud Storage. Os buckets do Cloud Storage precisam estar na mesma região das instâncias.

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

string

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

ManagedBackupSource

Backups gerados e gerenciados pelo Memorystore.

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/{backupId}. Nesse caso, pressupõe-se que o backup esteja em memorystore.googleapis.com.

Estado

Estados possíveis da instância.

Enums
STATE_UNSPECIFIED Não definido
CREATING A instância está sendo criada.
ACTIVE A instância foi criada e pode ser usada.
UPDATING A instância está sendo atualizada.
DELETING A instância está sendo excluída.

StateInfo

Outras informações sobre o estado da instância.

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 está em UPDATING.

UpdateInfo

Representa informações sobre a instância com o estado UPDATING.

Representação JSON
{
  "targetShardCount": integer,
  "targetReplicaCount": integer,
  "targetEngineVersion": string,
  "targetNodeType": enum (NodeType)
}
Campos
targetShardCount

integer

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

targetReplicaCount

integer

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

targetEngineVersion

string

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

targetNodeType

enum (NodeType)

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

AuthorizationMode

Possíveis modos de autorização da instância.

Enums
AUTHORIZATION_MODE_UNSPECIFIED Não definido
AUTH_DISABLED Autorização desativada.
IAM_AUTH Autorização básica do IAM.

TransitEncryptionMode

Possíveis modos de criptografia em trânsito da instância.

Enums
TRANSIT_ENCRYPTION_MODE_UNSPECIFIED Não definido
TRANSIT_ENCRYPTION_DISABLED A criptografia em trânsito está desativada.
SERVER_AUTHENTICATION A criptografia gerenciada pelo servidor é usada para criptografia em trânsito.

DiscoveryEndpoint

Representa um endpoint para os clientes se conectarem à instância.

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

string

Apenas saída. Endereço IP do endpoint exposto ao qual 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/{networkProject}/global/networks/{network_id}.

PersistenceConfig

Representa a configuração de persistência de uma instância.

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. Este campo será ignorado se o modo não for RDB.

aofConfig

object (AOFConfig)

Opcional. Configuração do AOF. Este campo será ignorado se o modo não for AOF.

PersistenceMode

Possíveis modos de persistência.

Enums
PERSISTENCE_MODE_UNSPECIFIED Não definido
DISABLED A persistência é desativada, e todos os dados de snapshot são excluídos.
RDB A persistência baseada em RDB está ativada.
AOF A persistência baseada em AOF está ativada.

RDBConfig

Configuração para persistência baseada em RDB.

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

enum (SnapshotPeriod)

Opcional. Período entre os snapshots do RDB.

rdbSnapshotStartTime

string (Timestamp format)

Opcional. Hora em que a primeira tentativa de criação do snapshot foi feita e a que os futuros snapshots serão alinhados. Se não for fornecido, o horário atual será usado.

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Deslocamentos diferentes de "Z" 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".

SnapshotPeriod

Possíveis períodos de snapshot.

Enums
SNAPSHOT_PERIOD_UNSPECIFIED Não definido
ONE_HOUR Uma hora.
SIX_HOURS Seis horas.
TWELVE_HOURS Doze horas.
TWENTY_FOUR_HOURS Vinte e quatro horas.

AOFConfig

Configuração para persistência baseada em AOF.

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

enum (AppendFsync)

Opcional. O modo fsync.

AppendFsync

Possíveis modos de sincronização de arquivos.

Enums
APPEND_FSYNC_UNSPECIFIED Não definido Padrão: EVERY_SEC
NEVER Nunca fsync. Normalmente, o Linux vai limpar os dados a cada 30 segundos com essa configuração, mas isso depende do ajuste exato do kernel.
EVERY_SEC Fsync a cada segundo. Você pode perder um segundo de dados em caso de desastre.
ALWAYS Fsync sempre que novos comandos de gravação são anexados ao AOF. A melhor proteção contra perda de dados com custo de desempenho.

NodeConfig

Representa a configuração dos nós da instância.

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

number

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

ZoneDistributionConfig

Configuração da distribuição de zonas para a alocação de recursos de instância.

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 para o modo MULTI_ZONE.

mode

enum (ZoneDistributionMode)

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

ZoneDistributionMode

Possíveis modos de distribuição de zonas.

Enums
ZONE_DISTRIBUTION_MODE_UNSPECIFIED Não definido. Padrão: MULTI_ZONE
MULTI_ZONE Distribua os recursos em três zonas escolhidas aleatoriamente na região.
SINGLE_ZONE Provisione recursos em uma única zona. O campo de zona precisa ser especificado.

PscAutoConnection

Detalhes dos recursos do consumidor em uma conexão de PSC.

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/{forwardingRule}

projectId

string

Obrigatório. O projectId do consumidor em que as conexões PSC são estabelecidas. Precisa ser o mesmo projectId 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/{projectId}/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 PSC: se uma conexão existe e está ATIVO 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 de 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 primário/leitor ou de descoberta.

PscConnectionStatus

Status da conexão do PSC.

Enums
PSC_CONNECTION_STATUS_UNSPECIFIED O status da conexão com o PSC não foi especificado.
ACTIVE A conexão está ativa
NOT_FOUND Conexão não encontrada

ConnectionType

Tipo de conexão PSC

Enums
CONNECTION_TYPE_UNSPECIFIED O tipo de conexão não está definido
CONNECTION_TYPE_DISCOVERY Conexão que será usada para a descoberta de topologia.
CONNECTION_TYPE_PRIMARY Conexão que será usada como endpoint principal para acessar o principal.
CONNECTION_TYPE_READER Conexão que será usada como endpoint de leitor para acessar as réplicas.

PscAttachmentDetail

Configuração de um anexo de serviço do cluster para criar conexões de PSC.

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

string

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

connectionType

enum (ConnectionType)

Apenas saída. Tipo de endpoint do PSC.

InstanceEndpoint

O InstanceEndpoint consiste em conexões PSC criadas como um grupo em cada rede VPC para acessar a instância. Em cada grupo, há uma conexão para cada anexo de serviço no cluster.

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

object (ConnectionDetail)

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

ConnectionDetail

Informações de cada conexão PSC.

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 PSC com uma instância pode ser criada pela automação de conectividade de 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 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

O usuário criou a configuração de conexão do Psc.

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/{forwardingRule}

projectId

string

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

network

string

Obrigatório. A rede do consumidor em que o endereço IP está localizado, no formato projects/{projectId}/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 PSC: se uma conexão existe e está ATIVO 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 de 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 primário/leitor ou de descoberta.

Modo

A configuração do modo, que é usada para ativar/desativar o modo de cluster.

Enums
MODE_UNSPECIFIED O modo não foi especificado.
STANDALONE

Descontinuado: use CLUSTER_DISABLED.

CLUSTER A instância está no modo de cluster.
CLUSTER_DISABLED O modo cluster está desativado para a instância.

MaintenancePolicy

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

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

string (Timestamp format)

Apenas saída. O horário em que a política foi criada.

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Deslocamentos diferentes de "Z" 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 RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Deslocamentos diferentes de "Z" 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 essa política. Mínimo 1. Para a versão atual, o número máximo de weekly_window deve ser um.

WeeklyMaintenanceWindow

Janela de tempo especificada para operações semanais.

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

enum (DayOfWeek)

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

startTime

object (TimeOfDay)

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

MaintenanceSchedule

Programação de manutenção futura.

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 RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Deslocamentos diferentes de "Z" 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 programada futura dessa instância.

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Deslocamentos diferentes de "Z" 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

Configuração de replicação entre instâncias.

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

enum (InstanceRole)

Obrigatório. O papel da instância na replicação entre instâncias.

primaryInstance

object (RemoteInstance)

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

Este campo é definido apenas para uma instância secundária.

secondaryInstances[]

object (RemoteInstance)

Opcional. Lista de instâncias secundárias que estão sendo replicadas a partir desta instância principal.

Esse campo é definido apenas 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 RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Deslocamentos diferentes de "Z" 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 membro que participam da replicação entre instâncias. Essa visualização será fornecida por cada instância de membro, independentemente do papel da instância(principal ou secundário).

Uma instância principal pode fornecer informações sobre todas as instâncias secundárias que a replicam. No entanto, uma instância secundária só conhece a instância principal de que ela está replicando. No entanto, para cenários em que a instância principal não está disponível(por exemplo, falha 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.

InstanceRole

O papel da instância na replicação entre instâncias.

Enums
INSTANCE_ROLE_UNSPECIFIED O papel da instância não está definido. O comportamento é equivalente a NENHUM.
NONE Essa instância não participa da replicação entre instâncias. Ela é uma instância independente e não é replicada para ou de outras instâncias.
PRIMARY Uma instância que permite leituras e gravações. Todos os dados gravados nessa instância também são replicados nas instâncias secundárias anexadas.
SECONDARY Uma instância que permite apenas leituras e replica dados de uma instância principal.

RemoteInstance

Detalhes da instância remota associada a esta instância em uma configuração de replicação entre instâncias.

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

string

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

uid

string

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

Associação

Uma visualização somente de saída de todas as instâncias de membro que participam da replicação entre instâncias.

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

object (RemoteInstance)

Apenas saída. A instância principal que atua como a origem da replicação das instâncias secundárias.

secondaryInstances[]

object (RemoteInstance)

Apenas saída. A lista de instâncias secundárias que estão sendo replicadas a partir da instância principal.

AutomatedBackupConfig

A configuração de backup automático de uma instância.

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 automatizado. Se o modo estiver desativado, os outros campos serão ignorados.

retention

string (Duration format)

Opcional. Por quanto tempo manter os backups automatizados antes da exclusão. O valor precisa estar entre 1 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 automáticos em uma frequência fixa.

FixedFrequencySchedule

Essa programação permite que o backup seja acionado em uma frequência fixa (atualmente, só é possível usar o diário).

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.

AutomatedBackupMode

O modo de backup automatizado.

Enums
AUTOMATED_BACKUP_MODE_UNSPECIFIED Valor padrão. A configuração de backup automático não foi especificada.
DISABLED Configuração de backup automático desativada.
ENABLED Configuração de backup automático ativada.

Métodos

backup

Instância de backup.

create

Cria uma nova instância em um determinado projeto e local.

delete

Exclui uma única instância.

get

Recebe detalhes de uma única instância.

getCertificateAuthority

Recebe detalhes sobre a autoridade certificadora de uma instância.

list

Lista instâncias em um determinado projeto e local.

patch

Atualiza os parâmetros de uma única instância.

rescheduleMaintenance

Reprograma o próximo evento de manutenção.