MCP Tools Reference: redis.googleapis.com

Ferramenta: create_cluster

Crie um cluster no Memorystore para Redis Cluster.

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

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

Esquema de entrada

Solicitação de CreateCluster.

CreateClusterRequest

Representação JSON 
{
  "parent": string,
  "clusterId": string,
  "cluster": {
    object (Cluster)
  },
  "requestId": string
}
Campos
parent

string

Obrigatório. O nome do recurso do local do cluster usando o formulário: projects/{project_id}/locations/{location_id}, em que location_id se refere a uma região do Google Cloud.
clusterId

string

Obrigatório. O nome lógico do cluster do Redis no projeto do cliente com as seguintes restrições:

  • Só pode ter letras minúsculas, números e hífens.
  • Precisa começar com uma letra.
  • Precisa ter entre 1 e 63 caracteres.
  • Precisa terminar com um número ou com uma letra.
  • Precisa ser único no projeto / local do cliente.
cluster

object (Cluster)

Obrigatório. O cluster a ser criado.
requestId

string

Opcional. UUID da solicitação idempotente.

Cluster

Representação JSON 
{
  "name": string,
  "createTime": string,
  "state": enum (State),
  "uid": string,
  "authorizationMode": enum (AuthorizationMode),
  "transitEncryptionMode": enum (TransitEncryptionMode),
  "pscConfigs": [
    {
      object (PscConfig)
    }
  ],
  "discoveryEndpoints": [
    {
      object (DiscoveryEndpoint)
    }
  ],
  "pscConnections": [
    {
      object (PscConnection)
    }
  ],
  "stateInfo": {
    object (StateInfo)
  },
  "nodeType": enum (NodeType),
  "persistenceConfig": {
    object (ClusterPersistenceConfig)
  },
  "redisConfigs": {
    string: string,
    ...
  },
  "zoneDistributionConfig": {
    object (ZoneDistributionConfig)
  },
  "crossClusterReplicationConfig": {
    object (CrossClusterReplicationConfig)
  },
  "pscServiceAttachments": [
    {
      object (PscServiceAttachment)
    }
  ],
  "clusterEndpoints": [
    {
      object (ClusterEndpoint)
    }
  ],
  "automatedBackupConfig": {
    object (AutomatedBackupConfig)
  },
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "availableMaintenanceVersions": [
    string
  ],
  "allowFewerZonesDeployment": boolean,
  "labels": {
    string: string,
    ...
  },
  "aclPolicy": string,

  // 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 _size_gb can be only one of the following:
  "sizeGb": integer
  // End of list of possible types for union field _size_gb.

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

  // Union field _precise_size_gb can be only one of the following:
  "preciseSizeGb": number
  // End of list of possible types for union field _precise_size_gb.

  // 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 _maintenance_policy can be only one of the following:
  "maintenancePolicy": {
    object (ClusterMaintenancePolicy)
  }
  // End of list of possible types for union field _maintenance_policy.

  // Union field _maintenance_schedule can be only one of the following:
  "maintenanceSchedule": {
    object (ClusterMaintenanceSchedule)
  }
  // End of list of possible types for union field _maintenance_schedule.

  // 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 _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 _backup_collection can be only one of the following:
  "backupCollection": string
  // End of list of possible types for union field _backup_collection.

  // 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 _ondemand_maintenance can be only one of the following:
  "ondemandMaintenance": boolean
  // End of list of possible types for union field _ondemand_maintenance.

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

  // 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_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

Obrigatório. Identificador. Nome exclusivo do recurso neste escopo, incluindo projeto e local usando o formulário: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}
createTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora associado à solicitação de criação do cluster.

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

enum (State)

Apenas saída. O estado atual deste cluster. Pode ser CREATING, READY, UPDATING, DELETING e SUSPENDED
uid

string

Apenas saída. Identificador exclusivo atribuído pelo sistema para o cluster.
authorizationMode

enum (AuthorizationMode)

Opcional. O modo de autorização do cluster do Redis. Se não for fornecido, o recurso de autenticação será desativado para o cluster.
transitEncryptionMode

enum (TransitEncryptionMode)

Opcional. A criptografia em trânsito para o cluster do Redis. Se não for fornecida, a criptografia será desativada para o cluster.
pscConfigs[]

object (PscConfig)

Opcional. Cada PscConfig configura a rede do consumidor em que os IPs serão designados ao cluster para acesso do cliente pela automação do Private Service Connect. No momento, apenas um PscConfig é aceito.
discoveryEndpoints[]

object (DiscoveryEndpoint)

Apenas saída. Endpoints criados em cada rede especificada para que os clientes do Redis se conectem ao cluster. No momento, apenas um endpoint de descoberta é aceito.
pscConnections[]

object (PscConnection)

Apenas saída. A lista de conexões do PSC criadas automaticamente pela automação de conectividade do serviço.
stateInfo

object (StateInfo)

Apenas saída. Outras informações sobre o estado atual do cluster.
nodeType

enum (NodeType)

Opcional. O tipo de um nó do Redis no cluster. NodeType determina o tipo de máquina de um nó do Redis.
persistenceConfig

object (ClusterPersistenceConfig)

Opcional. Configuração de persistência (RDB, AOF) para o cluster.
redisConfigs

map (key: string, value: string)

Opcional. Pares de chave/valor de substituições do cliente para configurações mutáveis do Redis.

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

object (ZoneDistributionConfig)

Opcional. Essa configuração será usada para determinar como o cliente quer que distribuamos os recursos do cluster na região.
crossClusterReplicationConfig

object (CrossClusterReplicationConfig)

Opcional. Configuração de replicação entre clusters.
pscServiceAttachments[]

object (PscServiceAttachment)

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

object (ClusterEndpoint)

Opcional. Uma lista de endpoints de cluster.
automatedBackupConfig

object (AutomatedBackupConfig)

Opcional. A configuração de backup automático do cluster.
encryptionInfo

object (EncryptionInfo)

Apenas saída. Informações de criptografia dos dados em repouso do cluster.
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.
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" }.
aclPolicy

string

Opcional. A política de ACL a ser aplicada ao cluster.
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. Backups armazenados em buckets do Cloud Storage. Os buckets do Cloud Storage precisam estar na mesma região que os clusters. A permissão de leitura é necessária para importar dos objetos fornecidos do Cloud Storage.
managedBackupSource

object (ManagedBackupSource)

Opcional. Backups gerados e gerenciados pelo serviço memorystore.

Campo de união _replica_count.

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

integer

Opcional. O número de nós de réplica por fragmento.

Campo de união _size_gb.

_size_gb pode ser apenas de um dos tipos a seguir:
sizeGb

integer

Apenas saída. Tamanho da memória do Redis em GB para todo o cluster, arredondado para o próximo número inteiro.

Campo de união _shard_count.

_shard_count pode ser apenas de um dos tipos a seguir:
shardCount

integer

Opcional. Número de fragmentos do cluster do Redis.

Campo de união _precise_size_gb.

_precise_size_gb pode ser apenas de um dos tipos a seguir:
preciseSizeGb

number

Apenas saída. Valor preciso do tamanho da memória do Redis em GB para todo o cluster.

Campo de união _deletion_protection_enabled.

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

boolean

Opcional. A operação de exclusão vai falhar quando o valor for definido como "true".

Campo de união _maintenance_policy.

_maintenance_policy pode ser apenas de um dos tipos a seguir:
maintenancePolicy

object (ClusterMaintenancePolicy)

Opcional. A ClusterMaintenancePolicy determina quando permitir ou negar atualizações.

Campo de união _maintenance_schedule.

_maintenance_schedule pode ser apenas de um dos tipos a seguir:
maintenanceSchedule

object (ClusterMaintenanceSchedule)

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

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 _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 _backup_collection.

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

string

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

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

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

boolean

Opcional. Somente entrada. Manutenção sob demanda para o cluster. Esse campo pode ser usado para acionar uma atualização crítica sob demanda no cluster.

Campo de união _async_cluster_endpoints_deletion_enabled.

_async_cluster_endpoints_deletion_enabled pode ser apenas de um dos tipos a seguir:
asyncClusterEndpointsDeletionEnabled

boolean

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

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 do cluster.

Campo de união _server_ca_mode.

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

enum (ServerCaMode)

Opcional. Modo de AC do servidor para o cluster.

Campo de união _server_ca_pool.

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

string

Opcional. Pool de ACs gerenciado pelo cliente para o cluster. Aplicável apenas para BYOCA, ou seja, se server_ca_mode for SERVER_CA_MODE_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_in_sync.

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

boolean

Opcional. Apenas saída. Indica se as regras de ACL aplicadas ao cluster estão sincronizadas com as regras mais recentes da política de ACL. Esse campo só é aplicável se a política de ACL estiver definida para o cluster.

GcsBackupSource

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

string

Opcional. URIs dos objetos do Cloud Storage a serem importados. Exemplo: gs://bucket1/object1, gs://bucket2/folder2/object2

ManagedBackupSource

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

string

Opcional. Exemplo: //redis.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 redis.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).

PscConfig

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

string

Obrigatório. A rede em que o endereço IP do endpoint de descoberta será reservado, no formato projects/{network_project}/global/networks/{network_id}.

DiscoveryEndpoint

Representação JSON 
{
  "address": string,
  "port": integer,
  "pscConfig": {
    object (PscConfig)
  }
}
Campos
address

string

Apenas saída. Endereço do endpoint do Redis exposto usado pelos clientes para se conectar ao serviço. O endereço pode ser IP ou nome do host.
port

integer

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

object (PscConfig)

Apenas saída. Configuração do cliente para o local em que o endpoint é criado e acessado.

PscConnection

Representação JSON 
{
  "pscConnectionId": string,
  "address": 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.
address

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. Exemplo: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}.
projectId

string

Opcional. 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 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. Esse valor é atualizado periodicamente. Para conferir o status mais recente de uma conexão do PSC, siga https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details.
connectionType

enum (ConnectionType)

Apenas saída. Tipo da conexão PSC.
Campo de união ports. O número da porta do endpoint de descoberta exposto. ports pode ser apenas de um dos tipos a seguir:
port

integer

Apenas saída. A porta só será definida para o endpoint principal/leitor ou de descoberta.

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)

Descreve a atualização em andamento no cluster quando o estado dele é 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_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

Número de fragmentos de destino para o cluster do Redis

Campo de união _target_replica_count.

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

integer

Número de nós de réplica por fragmento desejado.

Campo de união _target_node_type.

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

enum (NodeType)

Tipo de nó de destino para cluster do Redis.

ClusterPersistenceConfig

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

enum (PersistenceMode)

Opcional. O modo de persistência.
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. O momento 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. Configuração de fsync.

RedisConfigsEntry

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

string
value

string

ZoneDistributionConfig

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

enum (ZoneDistributionMode)

Opcional. O modo de distribuição de zonas. O padrão é MULTI_ZONE quando não especificado.
zone

string

Opcional. Quando a distribuição de ZONA ÚNICA é selecionada, o campo de zona é usado para alocar todos os recursos nessa zona. Isso não se aplica a MULTI_ZONE e seria ignorado para clusters MULTI_ZONE.

CrossClusterReplicationConfig

Representação JSON 
{
  "clusterRole": enum (ClusterRole),
  "primaryCluster": {
    object (RemoteCluster)
  },
  "secondaryClusters": [
    {
      object (RemoteCluster)
    }
  ],
  "updateTime": string,
  "membership": {
    object (Membership)
  }
}
Campos
clusterRole

enum (ClusterRole)

Apenas saída. A função do cluster na replicação entre clusters.
primaryCluster

object (RemoteCluster)

Detalhes do cluster principal usado como origem de replicação para este cluster secundário.

Esse campo só é definido para um cluster secundário.
secondaryClusters[]

object (RemoteCluster)

Lista de clusters secundários que estão replicando deste cluster principal.

Esse campo só é definido para um cluster principal.
updateTime

string (Timestamp format)

Apenas saída. A última vez que a configuração de replicação entre clusters 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 todos os clusters membros que participam da replicação entre clusters. Essa visualização é fornecida por todos os clusters membros, independente da função(principal ou secundária).

Um cluster principal pode fornecer informações sobre todos os clusters secundários que estão replicando dele. No entanto, um cluster secundário só conhece o cluster principal de que está replicando. No entanto, em cenários em que o cluster principal não está disponível(por exemplo, uma interrupção regional), uma solicitação "GetCluster" pode ser enviada a qualquer outro cluster de membro, e esse campo vai listar todos os clusters de membros que participam da replicação entre clusters.

RemoteCluster

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

string

Apenas saída. O caminho completo do recurso do cluster remoto no formato: projects//locations//clusters/
uid

string

Apenas saída. O identificador exclusivo do cluster remoto.

Associação

Representação JSON 
{
  "primaryCluster": {
    object (RemoteCluster)
  },
  "secondaryClusters": [
    {
      object (RemoteCluster)
    }
  ]
}
Campos
primaryCluster

object (RemoteCluster)

Apenas saída. O cluster principal que atua como origem da replicação para os clusters secundários.
secondaryClusters[]

object (RemoteCluster)

Apenas saída. A lista de clusters secundários que replicam do cluster principal.

ClusterMaintenancePolicy

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

string (Timestamp format)

Apenas saída. O momento em que a política foi criada, ou seja, a janela de manutenção ou o período de negação foi atribuído.

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 momento em que a política foi atualizada, ou seja, a janela de manutenção ou o período de negação foi atualizado.

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 (ClusterWeeklyMaintenanceWindow)

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_maintenance_window é um.

ClusterWeeklyMaintenanceWindow

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.

ClusterMaintenanceSchedule

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

PscServiceAttachment

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ê mesmo deve usar como destino.
connectionType

enum (ConnectionType)

Apenas saída. Tipo de uma conexão do PSC que segmenta este anexo de serviço.

ClusterEndpoint

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

object (ConnectionDetail)

Obrigatório. 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 um cluster pode ser criada pela automação de conectividade de serviço (conexão registrada automaticamente) durante a criação do cluster ou pelo próprio cliente (conexão registrada pelo usuário). connection pode ser apenas de um dos tipos a seguir:
pscAutoConnection

object (PscAutoConnection)

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 cliente proprietário do cluster.

PscAutoConnection

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

string

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

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. Exemplo: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}.
projectId

string

Obrigatório. 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

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

AutomatedBackupConfig

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

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

  // Union field _retention can be only one of the following:
  "retention": string
  // End of list of possible types for union field _retention.
}
Campos
automatedBackupMode

enum (AutomatedBackupMode)

Opcional. O modo de backup automático. Se o modo estiver desativado, os outros campos serão ignorados.
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.

Campo de união _retention.

_retention pode ser apenas de um dos tipos a seguir:
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".

FixedFrequencySchedule

Representação JSON 
{

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

Campo de união _start_time.

_start_time pode ser apenas de um dos tipos a seguir:
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).

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

LabelsEntry

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

string
value

string

Esquema de saída

Este recurso representa uma operação de longa duração resultante de uma chamada de API de rede.

Operação

Representação JSON 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // Union field result can be only one of the following:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of list of possible types for union field result.
}
Campos
name

string

O nome atribuído pelo servidor, que é exclusivo somente no mesmo serviço que o retorna originalmente. Se você usar o mapeamento padrão de HTTP, name precisa ser um nome de recurso que termine com operations/{unique_id}.
metadata

object

{

createTime: o horário em que a operação foi criada.

endTime: a hora em que a operação terminou de ser executada.

target: caminho do recurso definido pelo servidor para o destino da operação.

verb: nome do verbo executado pela operação.

statusDetail: status legível da operação, caso haja um.

cancelRequested: identifica se o usuário solicitou o cancelamento da operação. As operações que foram canceladas com êxito têm o valor Operation.error com um google.rpc.Status.code de 1, correspondente a Code.CANCELLED.

apiVersion: versão da API usada para iniciar a operação.

}

Um objeto contendo campos de um tipo arbitrário. Um campo adicional "@type" contém uma URI que identifica o tipo. Exemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.
done

boolean

Se o valor for false, significa que a operação ainda está em andamento. Se for true, a operação será concluída e error ou response estarão disponíveis.
Campo de união result. O resultado da operação, que pode ser um error ou uma response válida. Se done == false, nem error ou response estão definidos. Se done == true, será possível definir exatamente um entre error ou response. Alguns serviços podem não fornecer o resultado. result pode ser apenas de um dos tipos a seguir:
error

object (Status)

Resultado do erro da operação em caso de falha ou cancelamento.
response

object

A resposta normal e bem-sucedida da operação. Se o método original não retornar dados em caso de sucesso, como Delete, a resposta será google.protobuf.Empty. Se o método original for Get/Create/Update padrão, a resposta será o recurso. Para outros métodos, a resposta precisa ser do tipo XxxResponse, em que Xxx é o nome do método original. Por exemplo, se o nome do método original for TakeSnapshot(), o tipo inferido de resposta será TakeSnapshotResponse.

Um objeto contendo campos de um tipo arbitrário. Um campo adicional "@type" contém uma URI que identifica o tipo. Exemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.

Qualquer

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

string

Identifica o tipo da mensagem Protobuf serializada com uma referência de URI que consiste em um prefixo que termina em uma barra e o nome de tipo totalmente qualificado.

Exemplo: type.googleapis.com/google.protobuf.StringValue

Essa string precisa conter pelo menos um caractere /, e o conteúdo após o último / precisa ser o nome totalmente qualificado do tipo na forma canônica, sem um ponto inicial. Não escreva um esquema nessas referências de URI para que os clientes não tentem entrar em contato com elas.

O prefixo é arbitrário, e as implementações do Protobuf devem remover tudo até o último /, inclusive, para identificar o tipo. type.googleapis.com/ é um prefixo padrão comum exigido por algumas implementações legadas. Esse prefixo não indica a origem do tipo, e não é esperado que URIs que o contenham respondam a solicitações.

Todas as strings de URL de tipo precisam ser referências de URI válidas com a restrição adicional (para o formato de texto) de que o conteúdo da referência deve consistir apenas em caracteres alfanuméricos, escapes codificados por porcentagem e caracteres no seguinte conjunto (sem incluir as crases externas): /-.~_!$&()*+,;=. Embora permitamos codificações de porcentagem, as implementações não devem remover o escape delas para evitar confusão com analisadores atuais. Por exemplo, type.googleapis.com%2FFoo deve ser rejeitado.

No design original do Any, foi considerada a possibilidade de iniciar um serviço de resolução de tipos nesses URLs de tipo, mas o Protobuf nunca implementou um e considera o contato com esses URLs problemático e um possível problema de segurança. Não tente usar URLs de tipo de contato.
value

string (bytes format)

Contém uma serialização Protobuf do tipo descrito por type_url.

Uma string codificada em base64.

Status

Representação JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Campos
code

integer

O código de status, que precisa ser um valor de enumeração de google.rpc.Code.
message

string

Uma mensagem de erro em inglês para o desenvolvedor. Qualquer mensagem de erro para o usuário precisa ser localizada e enviada no campo google.rpc.Status.details, ou localizada pelo cliente.
details[]

object

Uma lista de mensagens com os detalhes do erro. Há um conjunto comum de tipos de mensagens para as APIs usarem.

Um objeto contendo campos de um tipo arbitrário. Um campo adicional "@type" contém uma URI que identifica o tipo. Exemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.

Anotações de ferramentas

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