MCP Tools Reference: redis.googleapis.com

Herramienta: create_cluster

Crea un clúster en Memorystore for Redis Cluster.

En el siguiente ejemplo, se muestra cómo usar curl para invocar la herramienta de MCP create_cluster.

Solicitud de 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

Solicitud para CreateCluster.

CreateClusterRequest

Representación JSON
{
  "parent": string,
  "clusterId": string,
  "cluster": {
    object (Cluster)
  },
  "requestId": string
}
Campos
parent

string

Obligatorio. Es el nombre del recurso de la ubicación del clúster con el formato projects/{project_id}/locations/{location_id}, en el que location_id hace referencia a una región de Google Cloud.

clusterId

string

Obligatorio. Es el nombre lógico del clúster de Redis en el proyecto del cliente con las siguientes restricciones:

  • Solo debe contener letras minúsculas, números y guiones.
  • Debe comenzar con una letra.
  • Debe tener entre 1 y 63 caracteres.
  • Debe terminar con un número o una letra.
  • Debe ser único en el proyecto o la ubicación del cliente.
cluster

object (Cluster)

Obligatorio. Es el clúster que se creará.

requestId

string

Es opcional. Es el UUID de la solicitud idempotente.

Clúster

Representación 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

Obligatorio. Es el identificador. Nombre único del recurso en este permiso, incluido el proyecto y la ubicación mediante el formulario: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}

createTime

string (Timestamp format)

Solo salida. Es la marca de tiempo asociada a la solicitud de creación del clúster.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

state

enum (State)

Solo salida. Es el estado actual de este clúster. Puede ser CREATING, READY, UPDATING, DELETING y SUSPENDED.

uid

string

Solo salida. Es el identificador único asignado por el sistema para el clúster.

authorizationMode

enum (AuthorizationMode)

Es opcional. Es el modo de autorización del clúster de Redis. Si no se proporciona, la función de autenticación se inhabilita para el clúster.

transitEncryptionMode

enum (TransitEncryptionMode)

Es opcional. Es la encriptación en tránsito para el clúster de Redis. Si no se proporciona, se inhabilita el encriptado para el clúster.

pscConfigs[]

object (PscConfig)

Es opcional. Cada PscConfig configura la red del consumidor en la que se designarán IPs al clúster para el acceso del cliente a través de la automatización de Private Service Connect. Actualmente, solo se admite un PscConfig.

discoveryEndpoints[]

object (DiscoveryEndpoint)

Solo salida. Son los extremos creados en cada red determinada para que los clientes de Redis se conecten al clúster. Actualmente, solo se admite un extremo de detección.

pscConnections[]

object (PscConnection)

Solo salida. Es la lista de conexiones de PSC que se crean automáticamente a través de la automatización de la conectividad del servicio.

stateInfo

object (StateInfo)

Solo salida. Es información adicional sobre el estado actual del clúster.

nodeType

enum (NodeType)

Es opcional. Es el tipo de un nodo de Redis en el clúster. NodeType determina el tipo de máquina subyacente de un nodo de Redis.

persistenceConfig

object (ClusterPersistenceConfig)

Es opcional. Es la configuración de persistencia (RDB, AOF) para el clúster.

redisConfigs

map (key: string, value: string)

Es opcional. Pares clave/valor de las anulaciones del cliente para los parámetros de configuración de Redis mutables

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

zoneDistributionConfig

object (ZoneDistributionConfig)

Es opcional. Esta configuración se usará para determinar cómo quiere el cliente que distribuyamos los recursos del clúster dentro de la región.

crossClusterReplicationConfig

object (CrossClusterReplicationConfig)

Es opcional. Es la configuración de la replicación entre clústeres.

pscServiceAttachments[]

object (PscServiceAttachment)

Solo salida. Detalles del adjunto de servicio para configurar conexiones de PSC

clusterEndpoints[]

object (ClusterEndpoint)

Es opcional. Es una lista de extremos del clúster.

automatedBackupConfig

object (AutomatedBackupConfig)

Es opcional. Es la configuración de copia de seguridad automática del clúster.

encryptionInfo

object (EncryptionInfo)

Solo salida. Es la información de encriptación de los datos en reposo del clúster.

availableMaintenanceVersions[]

string

Solo salida. Este campo se usa para determinar las versiones de mantenimiento disponibles para la actualización de autoservicio.

allowFewerZonesDeployment
(deprecated)

boolean

Es opcional. Inmutable. Está obsoleto, no se debe usar.

labels

map (key: string, value: string)

Es opcional. Son etiquetas que representan los metadatos proporcionados por el usuario.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

aclPolicy

string

Es opcional. Es la política de ACL que se aplicará al clúster.

Campo de unión import_sources. Es la fuente desde la que se importará. import_sources puede ser solo uno de los parámetros siguientes:
gcsSource

object (GcsBackupSource)

Es opcional. Copias de seguridad almacenadas en buckets de Cloud Storage Los buckets de Cloud Storage deben estar en la misma región que los clústeres. Se requiere permiso de lectura para importar desde los objetos de Cloud Storage proporcionados.

managedBackupSource

object (ManagedBackupSource)

Es opcional. Son las copias de seguridad que genera y administra el servicio de Memorystore.

Campo de unión _replica_count.

_replica_count puede ser una de las siguientes opciones:

replicaCount

integer

Es opcional. Es la cantidad de nodos de réplica por fragmento.

Campo de unión _size_gb.

_size_gb puede ser una de las siguientes opciones:

sizeGb

integer

Solo salida. Tamaño de la memoria de Redis en GB para todo el clúster, redondeado al siguiente número entero.

Campo de unión _shard_count.

_shard_count puede ser una de las siguientes opciones:

shardCount

integer

Es opcional. Es la cantidad de fragmentos del clúster de Redis.

Campo de unión _precise_size_gb.

_precise_size_gb puede ser una de las siguientes opciones:

preciseSizeGb

number

Solo salida. Es el valor preciso del tamaño de la memoria de Redis en GB para todo el clúster.

Campo de unión _deletion_protection_enabled.

_deletion_protection_enabled puede ser una de las siguientes opciones:

deletionProtectionEnabled

boolean

Es opcional. La operación de eliminación fallará cuando el valor se establezca como verdadero.

Campo de unión _maintenance_policy.

_maintenance_policy puede ser una de las siguientes opciones:

maintenancePolicy

object (ClusterMaintenancePolicy)

Es opcional. ClusterMaintenancePolicy determina cuándo permitir o rechazar actualizaciones.

Campo de unión _maintenance_schedule.

_maintenance_schedule puede ser una de las siguientes opciones:

maintenanceSchedule

object (ClusterMaintenanceSchedule)

Solo salida. ClusterMaintenanceSchedule (solo salida) Programa de mantenimiento publicado.

Campo de unión _satisfies_pzs.

_satisfies_pzs puede ser una de las siguientes opciones:

satisfiesPzs

boolean

Es opcional. Solo salida. Se reserva para usarlo más adelante.

Campo de unión _satisfies_pzi.

_satisfies_pzi puede ser una de las siguientes opciones:

satisfiesPzi

boolean

Es opcional. Solo salida. Se reserva para usarlo más adelante.

Campo de unión _simulate_maintenance_event.

_simulate_maintenance_event puede ser una de las siguientes opciones:

simulateMaintenanceEvent

boolean

Es opcional. Solo entrada. Simula un evento de mantenimiento.

Campo de unión _backup_collection.

_backup_collection puede ser una de las siguientes opciones:

backupCollection

string

Es opcional. Solo salida. Es el nombre completo del recurso de la colección de copias de seguridad. Ejemplo: projects/{project}/locations/{location}/backupCollections/{collection}

Campo de unión _kms_key.

_kms_key puede ser una de las siguientes opciones:

kmsKey

string

Es opcional. Es la clave de KMS que se usa para encriptar los datos en reposo del clúster.

Campo de unión _ondemand_maintenance.

_ondemand_maintenance puede ser una de las siguientes opciones:

ondemandMaintenance
(deprecated)

boolean

Es opcional. Solo entrada. Es el mantenimiento a pedido del clúster. Este campo se puede usar para activar una actualización crítica a pedido en el clúster.

Campo de unión _async_cluster_endpoints_deletion_enabled.

_async_cluster_endpoints_deletion_enabled puede ser una de las siguientes opciones:

asyncClusterEndpointsDeletionEnabled

boolean

Es opcional. Si es verdadero, los extremos del clúster que crean y registran los clientes se pueden borrar de forma asíncrona. Es decir, ese extremo del clúster se puede anular antes de que se borren las reglas de reenvío en el extremo del clúster.

Campo de unión _maintenance_version.

_maintenance_version puede ser una de las siguientes opciones:

maintenanceVersion

string

Es opcional. Este campo se puede usar para activar la actualización de autoservicio y, así, indicar la versión de mantenimiento deseada. El campo available_maintenance_versions puede determinar la entrada de este campo.

Campo de unión _effective_maintenance_version.

_effective_maintenance_version puede ser una de las siguientes opciones:

effectiveMaintenanceVersion

string

Solo salida. Este campo representa la versión de mantenimiento real del clúster.

Campo de unión _server_ca_mode.

_server_ca_mode puede ser una de las siguientes opciones:

serverCaMode

enum (ServerCaMode)

Es opcional. Es el modo de AC del servidor para el clúster.

Campo de unión _server_ca_pool.

_server_ca_pool puede ser una de las siguientes opciones:

serverCaPool

string

Es opcional. Es el grupo de AC administrado por el cliente para el clúster. Solo se aplica a BYOCA, es decir, si server_ca_mode es SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA. Formato: "projects/{project}/locations/{region}/caPools/{ca_pool}".

Campo de unión _rotate_server_certificate.

_rotate_server_certificate puede ser una de las siguientes opciones:

rotateServerCertificate

boolean

Es opcional. Solo entrada. Rota los certificados del servidor.

Campo de unión _acl_policy_in_sync.

_acl_policy_in_sync puede ser una de las siguientes opciones:

aclPolicyInSync

boolean

Es opcional. Solo salida. Indica si las reglas de LCA aplicadas al clúster están sincronizadas con las reglas de la política de LCA más reciente. Este campo solo se aplica si se establece la política de LCA para el clúster.

GcsBackupSource

Representación JSON
{
  "uris": [
    string
  ]
}
Campos
uris[]

string

Es opcional. Son los URIs de los objetos de Cloud Storage que se importarán. Ejemplo: gs://bucket1/object1, gs://bucket2/folder2/object2

ManagedBackupSource

Representación JSON
{
  "backup": string
}
Campos
backup

string

Es opcional. Ejemplo: //redis.googleapis.com/projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup} También se admite una versión más corta (sin el prefijo) del nombre de la copia de seguridad, como projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup_id}. En este caso, se supone que la copia de seguridad está en redis.googleapis.com.

Marca de tiempo

Representación JSON
{
  "seconds": string,
  "nanos": integer
}
Campos
seconds

string (int64 format)

Representa los segundos de la hora UTC desde la época de Unix 1970-01-01T00:00:00Z. Debe estar entre -62135596800 y 253402300799 inclusive (lo que corresponde a 0001-01-01T00:00:00Z a 9999-12-31T23:59:59Z).

nanos

integer

Fracciones no negativas de un segundo a una resolución de nanosegundos. Este campo es la parte de la duración en nanosegundos, no una alternativa a los segundos. Los valores de segundos negativos con fracciones deben tener valores nanos no negativos que se cuentan hacia adelante en el tiempo. Debe ser un valor entre 0 y 999,999,999, inclusive.

PscConfig

Representación JSON
{
  "network": string
}
Campos
network

string

Obligatorio. Es la red en la que se reservará la dirección IP del extremo de detección, con el formato projects/{network_project}/global/networks/{network_id}.

DiscoveryEndpoint

Representación JSON
{
  "address": string,
  "port": integer,
  "pscConfig": {
    object (PscConfig)
  }
}
Campos
address

string

Solo salida. Es la dirección del extremo de Redis expuesto que usan los clientes para conectarse al servicio. La dirección puede ser una IP o un nombre de host.

port

integer

Solo salida. Número de puerto del extremo de Redis expuesto.

pscConfig

object (PscConfig)

Solo salida. Es la configuración del cliente para determinar dónde se crea el extremo y desde dónde se accede a él.

PscConnection

Representación 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

Obligatorio. Es el ID de conexión de PSC de la regla de reenvío conectada al adjunto de servicio.

address

string

Obligatorio. Es la IP asignada en la red del consumidor para la regla de reenvío de PSC.

forwardingRule

string

Obligatorio. Es el URI de la regla de reenvío del lado del consumidor. Ejemplo: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}.

projectId

string

Es opcional. Es el ID del proyecto del consumidor en el que se crea la regla de reenvío.

network

string

Obligatorio. Es la red del consumidor en la que reside la dirección IP, con el formato projects/{project_id}/global/networks/{network_id}.

serviceAttachment

string

Obligatorio. Es el adjunto de servicio que es el destino de la conexión de PSC, con el formato projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}.

pscConnectionStatus

enum (PscConnectionStatus)

Solo salida. Es el estado de la conexión de PSC. Ten en cuenta que este valor se actualiza periódicamente. Para obtener el estado más reciente de una conexión de PSC, consulta https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details.

connectionType

enum (ConnectionType)

Solo salida. Es el tipo de conexión de PSC.

Campo de unión ports. Es el número de puerto del extremo de detección expuesto. ports puede ser solo uno de los parámetros siguientes:
port

integer

Solo salida. El puerto solo se establecerá para el extremo principal o de lectura, o de descubrimiento.

StateInfo

Representación 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ón info.

info puede ser una de las siguientes opciones:

updateInfo

object (UpdateInfo)

Describe la actualización en curso del clúster cuando el estado del clúster es UPDATING.

UpdateInfo

Representación 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ón _target_shard_count.

_target_shard_count puede ser una de las siguientes opciones:

targetShardCount

integer

Cantidad objetivo de fragmentos para el clúster de Redis

Campo de unión _target_replica_count.

_target_replica_count puede ser una de las siguientes opciones:

targetReplicaCount

integer

Es la cantidad objetivo de nodos de réplica por fragmento.

Campo de unión _target_node_type.

_target_node_type puede ser una de las siguientes opciones:

targetNodeType

enum (NodeType)

Es el tipo de nodo de destino para el clúster de Redis.

ClusterPersistenceConfig

Representación JSON
{
  "mode": enum (PersistenceMode),
  "rdbConfig": {
    object (RDBConfig)
  },
  "aofConfig": {
    object (AOFConfig)
  }
}
Campos
mode

enum (PersistenceMode)

Es opcional. Es el modo de persistencia.

rdbConfig

object (RDBConfig)

Es opcional. Es la configuración de la RDB. Este campo se ignorará si el modo no es RDB.

aofConfig

object (AOFConfig)

Es opcional. Configuración de AOF Este campo se ignorará si el modo no es AOF.

RDBConfig

Representación JSON
{
  "rdbSnapshotPeriod": enum (SnapshotPeriod),
  "rdbSnapshotStartTime": string
}
Campos
rdbSnapshotPeriod

enum (SnapshotPeriod)

Es opcional. Es el período entre las instantáneas de RDB.

rdbSnapshotStartTime

string (Timestamp format)

Es opcional. Es la fecha y hora en que se intentó o se intentará tomar la primera instantánea, y con la que se alinearán las instantáneas futuras. Si no se proporciona, se usará la hora actual.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

AOFConfig

Representación JSON
{
  "appendFsync": enum (AppendFsync)
}
Campos
appendFsync

enum (AppendFsync)

Opcional. Es la configuración de fsync.

RedisConfigsEntry

Representación JSON
{
  "key": string,
  "value": string
}
Campos
key

string

value

string

ZoneDistributionConfig

Representación JSON
{
  "mode": enum (ZoneDistributionMode),
  "zone": string
}
Campos
mode

enum (ZoneDistributionMode)

Es opcional. Es el modo de distribución de zonas. El valor predeterminado es MULTI_ZONE cuando no se especifica.

zone

string

Es opcional. Cuando se selecciona la distribución de ZONA ÚNICA, el campo de zona se usa para asignar todos los recursos en esa zona. Esto no se aplica a MULTI_ZONE y se ignorará para los clústeres de MULTI_ZONE.

CrossClusterReplicationConfig

Representación JSON
{
  "clusterRole": enum (ClusterRole),
  "primaryCluster": {
    object (RemoteCluster)
  },
  "secondaryClusters": [
    {
      object (RemoteCluster)
    }
  ],
  "updateTime": string,
  "membership": {
    object (Membership)
  }
}
Campos
clusterRole

enum (ClusterRole)

Solo salida. Es el rol del clúster en la replicación entre clústeres.

primaryCluster

object (RemoteCluster)

Son los detalles del clúster principal que se usa como fuente de replicación para este clúster secundario.

Este campo solo se establece para un clúster secundario.

secondaryClusters[]

object (RemoteCluster)

Es la lista de clústeres secundarios que se replican desde este clúster principal.

Este campo solo se establece para un clúster principal.

updateTime

string (Timestamp format)

Solo salida. Es la última vez que se actualizó la configuración de la replicación entre clústeres.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

membership

object (Membership)

Solo salida. Es una vista de solo salida de todos los clústeres miembros que participan en la replicación entre clústeres. Cada clúster miembro proporcionará esta vista, independientemente de su rol de clúster(principal o secundario).

Un clúster principal puede proporcionar información sobre todos los clústeres secundarios que se replican desde él. Sin embargo, un clúster secundario solo conoce el clúster principal desde el que se replica. Sin embargo, en situaciones en las que el clúster principal no está disponible(p.ej., una interrupción regional), se puede enviar una solicitud GetCluster a cualquier otro clúster miembro, y este campo mostrará todos los clústeres miembros que participan en la replicación entre clústeres.

RemoteCluster

Representación JSON
{
  "cluster": string,
  "uid": string
}
Campos
cluster

string

Solo salida. Ruta de acceso completa del recurso del clúster remoto con el siguiente formato: projects//locations//clusters/

uid

string

Solo salida. Es el identificador único del clúster remoto.

Membresía

Representación JSON
{
  "primaryCluster": {
    object (RemoteCluster)
  },
  "secondaryClusters": [
    {
      object (RemoteCluster)
    }
  ]
}
Campos
primaryCluster

object (RemoteCluster)

Solo salida. Es el clúster principal que actúa como fuente de replicación para los clústeres secundarios.

secondaryClusters[]

object (RemoteCluster)

Solo salida. Es la lista de clústeres secundarios que se replican desde el clúster principal.

ClusterMaintenancePolicy

Representación JSON
{
  "createTime": string,
  "updateTime": string,
  "weeklyMaintenanceWindow": [
    {
      object (ClusterWeeklyMaintenanceWindow)
    }
  ]
}
Campos
createTime

string (Timestamp format)

Solo salida. Es la fecha y hora en que se creó la política, es decir, se asignó el período de mantenimiento o el período de rechazo.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Solo salida. Es la fecha y hora en que se actualizó la política, es decir, el período de mantenimiento o el período de denegación.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

weeklyMaintenanceWindow[]

object (ClusterWeeklyMaintenanceWindow)

Es opcional. Es el período de mantenimiento que se aplica a los recursos cubiertos por esta política. El mínimo es 1. Para la versión actual, se espera que la cantidad máxima de weekly_maintenance_window sea uno.

ClusterWeeklyMaintenanceWindow

Representación JSON
{
  "day": enum (google.type.DayOfWeek),
  "startTime": {
    object (TimeOfDay)
  }
}
Campos
day

enum (google.type.DayOfWeek)

Es opcional. Permite definir una programación que se ejecute en un día específico de la semana.

startTime

object (TimeOfDay)

Es opcional. Hora de inicio del período en UTC.

TimeOfDay

Representación JSON
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Campos
hours

integer

Horas de un día en formato de 24 horas. Debe ser mayor o igual que 0 y, por lo general, debe ser menor o igual que 23. Una API puede permitir el valor “24:00:00” para casos como el horario de cierre de empresas.

minutes

integer

Minutos de una hora. Debe ser mayor o igual que 0 y menor o igual que 59.

seconds

integer

Segundos de un minuto. Debe ser mayor o igual que 0 y, por lo general, debe ser menor o igual que 59. Una API puede permitir el valor 60 si permite segundos bisiestos.

nanos

integer

Fracciones de segundos, en nanosegundos. Debe ser mayor o igual que 0 y menor o igual que 999,999,999.

ClusterMaintenanceSchedule

Representación JSON
{
  "startTime": string,
  "endTime": string
}
Campos
startTime

string (Timestamp format)

Solo salida. Es la hora de inicio de cualquier mantenimiento programado próximo para esta instancia.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

endTime

string (Timestamp format)

Solo salida. Es la hora de finalización de cualquier mantenimiento programado próximo para esta instancia.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

PscServiceAttachment

Representación JSON
{
  "serviceAttachment": string,
  "connectionType": enum (ConnectionType)
}
Campos
serviceAttachment

string

Solo salida. Es el URI del adjunto de servicio que tu PscConnection creado por ti mismo debe usar como destino.

connectionType

enum (ConnectionType)

Solo salida. Es el tipo de conexión de PSC que segmenta este adjunto de servicio.

ClusterEndpoint

Representación JSON
{
  "connections": [
    {
      object (ConnectionDetail)
    }
  ]
}
Campos
connections[]

object (ConnectionDetail)

Obligatorio. Es un grupo de conexiones de PSC. Se crean en la misma red de VPC, una para cada adjunto de servicio del clúster.

ConnectionDetail

Representación 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ón connection. Se puede crear una conexión de PSC a un clúster a través de la automatización de la conectividad del servicio (conexión registrada automáticamente) durante la creación del clúster, o bien el cliente puede crearla por su cuenta (conexión registrada por el usuario). connection puede ser solo uno de los parámetros siguientes:
pscAutoConnection

object (PscAutoConnection)

Es la información detallada de una conexión de PSC que se crea a través de la automatización de la conectividad del servicio.

pscConnection

object (PscConnection)

Es la información detallada de una conexión de PSC creada por el cliente propietario del clúster.

PscAutoConnection

Representación JSON
{
  "pscConnectionId": string,
  "address": string,
  "forwardingRule": string,
  "projectId": string,
  "network": string,
  "serviceAttachment": string,
  "pscConnectionStatus": enum (PscConnectionStatus),
  "connectionType": enum (ConnectionType)
}
Campos
pscConnectionId

string

Solo salida. Es el ID de conexión de PSC de la regla de reenvío conectada al adjunto de servicio.

address

string

Solo salida. Es la IP asignada en la red del consumidor para la regla de reenvío de PSC.

forwardingRule

string

Solo salida. Es el URI de la regla de reenvío del lado del consumidor. Ejemplo: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}.

projectId

string

Obligatorio. Es el ID del proyecto de consumidor desde el que se crea la regla de reenvío.

network

string

Obligatorio. Es la red del consumidor en la que reside la dirección IP, con el formato projects/{project_id}/global/networks/{network_id}.

serviceAttachment

string

Solo salida. Es el adjunto de servicio que es el destino de la conexión de PSC, con el formato projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}.

pscConnectionStatus

enum (PscConnectionStatus)

Solo salida. Es el estado de la conexión de PSC. Ten en cuenta que este valor se actualiza periódicamente. Usa las APIs de Private Service Connect para conocer el estado más reciente.

connectionType

enum (ConnectionType)

Solo salida. Es el tipo de conexión de PSC.

AutomatedBackupConfig

Representación 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)

Es opcional. Es el modo de copia de seguridad automática. Si el modo está inhabilitado, se ignorarán los demás campos.

Campo de unión schedule. Es el programa de copias de seguridad automáticas. schedule puede ser solo uno de los parámetros siguientes:
fixedFrequencySchedule

object (FixedFrequencySchedule)

Es opcional. Activa copias de seguridad automáticas con una frecuencia fija.

Campo de unión _retention.

_retention puede ser una de las siguientes opciones:

retention

string (Duration format)

Es opcional. Es el tiempo durante el que se conservan las copias de seguridad automáticas antes de que se borren. El valor debe estar entre 1 y 365 días. Si no se especifica, el valor predeterminado es 35 días.

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".

FixedFrequencySchedule

Representación 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ón _start_time.

_start_time puede ser una de las siguientes opciones:

startTime

object (TimeOfDay)

Obligatorio. Es la hora de inicio de cada copia de seguridad automática en UTC. Debe establecerse al inicio de una hora. Este campo es obligatorio.

Duración

Representación JSON
{
  "seconds": string,
  "nanos": integer
}
Campos
seconds

string (int64 format)

Son los segundos firmados del período. Debe estar entre -315,576,000,000 y +315,576,000,000, inclusive. Nota: Estos límites se calculan de la siguiente manera: 60 s/min * 60 min/h * 24 h/día * 365.25 días/año * 10,000 años

nanos

integer

Fracciones firmadas de un segundo con una resolución de nanosegundos del período. Las duraciones inferiores a un segundo se representan con un campo seconds igual a 0 y un campo nanos positivo o negativo. Para duraciones de un segundo o más, un valor distinto de cero para el campo nanos debe tener el mismo signo que el campo seconds. Debe ser un valor entre -999,999,999 y +999,999,999, inclusive.

EncryptionInfo

Representación JSON
{
  "encryptionType": enum (Type),
  "kmsKeyVersions": [
    string
  ],
  "kmsKeyPrimaryState": enum (KmsKeyState),
  "lastUpdateTime": string
}
Campos
encryptionType

enum (Type)

Solo salida. Tipo de encriptación.

kmsKeyVersions[]

string

Solo salida. Son las versiones de clave de KMS que se usan para proteger los datos en reposo.

kmsKeyPrimaryState

enum (KmsKeyState)

Solo salida. Es el estado de la versión principal de la clave de KMS que percibe el sistema. Este campo no se completa en las copias de seguridad.

lastUpdateTime

string (Timestamp format)

Solo salida. Es la fecha y hora más reciente en la que se actualizó la información de encriptación.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

LabelsEntry

Representación JSON
{
  "key": string,
  "value": string
}
Campos
key

string

value

string

Esquema de salida

Este recurso representa una operación de larga duración que es el resultado de una llamada a la API de la red.

Operación

Representación 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

El nombre asignado por el servidor, que solo es único dentro del mismo servicio que lo muestra en un principio. Si usas la asignación HTTP predeterminada, el name debe ser un nombre de recurso que termine con operations/{unique_id}.

metadata

object

{

createTime: Es la fecha y hora en que se creó la operación.

endTime: Es la hora en la que finalizó la operación.

target: Es la ruta de acceso al recurso definida por el servidor para el destino de la operación.

verb: Nombre del verbo que ejecuta la operación.

statusDetail: Estado legible de la operación, si lo hay.

cancelRequested: Identifica si el usuario solicitó la cancelación de la operación. Las operaciones que se cancelaron de forma correcta tienen el valor Operation.error con un google.rpc.Status.code de 1, que corresponde a Code.CANCELLED.

apiVersion: Es la versión de la API que se usó para iniciar la operación.

}

Un objeto que contiene campos de un tipo arbitrario. Un campo adicional "@type" contiene una URI que identifica el tipo. Ejemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.

done

boolean

Si el valor es false, significa que la operación aún está en progreso. Si es true, la operación está completa, y error o response están disponibles.

Campo de unión result. El resultado de la operación, que puede ser un error o una response válida. Si done == false, no se establecen error ni response. Si done == true, se puede establecer error o response. Es posible que algunos servicios no proporcionen el resultado. result puede ser solo uno de los siguientes:
error

object (Status)

El resultado de error de la operación en caso de falla o cancelación.

response

object

Es la respuesta normal y correcta de la operación. Si el método original no devuelve datos en caso de éxito, como Delete, la respuesta es google.protobuf.Empty. Si el método original es Get, Create o Update estándar, la respuesta debe ser el recurso. Para otros métodos, la respuesta debe tener el tipo XxxResponse, en la que Xxx es el nombre del método original. Por ejemplo, si el nombre del método original es TakeSnapshot(), el tipo de respuesta inferido es TakeSnapshotResponse.

Un objeto que contiene campos de un tipo arbitrario. Un campo adicional "@type" contiene una URI que identifica el tipo. Ejemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.

Cualquiera

Representación JSON
{
  "typeUrl": string,
  "value": string
}
Campos
typeUrl

string

Identifica el tipo del mensaje serializado de Protobuf con una referencia de URI que consta de un prefijo que termina en una barra y el nombre de tipo completo.

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

Esta cadena debe contener al menos un carácter /, y el contenido después del último / debe ser el nombre completamente calificado del tipo en formato canónico, sin un punto inicial. No escribas un esquema en estas referencias de URI para que los clientes no intenten comunicarse con ellas.

El prefijo es arbitrario, y se espera que las implementaciones de Protobuf simplemente quiten todo hasta el último / inclusive para identificar el tipo. type.googleapis.com/ es un prefijo predeterminado común que requieren algunas implementaciones heredadas. Este prefijo no indica el origen del tipo, y no se espera que los URIs que lo contienen respondan a ninguna solicitud.

Todas las cadenas de URL de tipo deben ser referencias URI legales con la restricción adicional (para el formato de texto) de que el contenido de la referencia solo debe constar de caracteres alfanuméricos, escapes codificados como porcentaje y caracteres del siguiente conjunto (sin incluir las comillas invertidas externas): /-.~_!$&()*+,;=. A pesar de que permitimos la codificación de porcentaje, las implementaciones no deben decodificarlas para evitar confusiones con los analizadores existentes. Por ejemplo, se debe rechazar type.googleapis.com%2FFoo.

En el diseño original de Any, se consideró la posibilidad de lanzar un servicio de resolución de tipos en estas URLs de tipos, pero Protobuf nunca implementó uno y considera que contactar estas URLs es problemático y un posible problema de seguridad. No intentes comunicarte con URLs de tipo.

value

string (bytes format)

Contiene una serialización de Protobuf del tipo que describe type_url.

Es una cadena codificada en Base64.

Estado

Representación JSON
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Campos
code

integer

El código de estado, que debe ser un valor enum de google.rpc.Code.

message

string

Un mensaje de error dirigido al desarrollador, que debe estar en inglés. Cualquier mensaje de error dirigido al usuario debe localizarse y enviarse al campo google.rpc.Status.details; o el cliente debe localizarlo.

details[]

object

Una lista de mensajes que contienen los detalles del error. Hay un conjunto común de tipos de mensajes para que usen las API.

Un objeto que contiene campos de un tipo arbitrario. Un campo adicional "@type" contiene una URI que identifica el tipo. Ejemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.

Anotaciones de herramientas

Sugerencia destructiva: ❌ | Sugerencia idempotente: ❌ | Sugerencia de solo lectura: ❌ | Sugerencia de mundo abierto: ❌