MCP Tools Reference: redis.googleapis.com

Outil : create_cluster

Créez un cluster dans Memorystore pour Redis Cluster.

L'exemple suivant montre comment utiliser curl pour appeler l'outil MCP create_cluster.

Requête 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
}'

Schéma d'entrée

Demande de CreateCluster.

CreateClusterRequest

Représentation JSON 
{
  "parent": string,
  "clusterId": string,
  "cluster": {
    object (Cluster)
  },
  "requestId": string
}
Champs
parent

string

Obligatoire. Nom de ressource de l'emplacement du cluster au format projects/{project_id}/locations/{location_id}, où location_id fait référence à une région Google Cloud.
clusterId

string

Obligatoire. Nom logique du cluster Redis dans le projet client, avec les restrictions suivantes :

  • Doit être composé de lettres minuscules, de chiffres et de traits d'union.
  • Doit commencer par une lettre.
  • Doit comporter entre 1 et 63 caractères.
  • Doit se terminer par un chiffre ou une lettre.
  • Doit être unique dans le projet/l'emplacement du client.
cluster

object (Cluster)

Obligatoire. Cluster à créer.
requestId

string

Facultatif. UUID de la requête idempotente.

Cluster

Représentation 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.
}
Champs
name

string

Obligatoire. Identifiant. Nom unique de la ressource dans ce champ d'application, y compris le projet et l'emplacement au format suivant : projects/{project_id}/locations/{location_id}/clusters/{cluster_id}
createTime

string (Timestamp format)

Uniquement en sortie. Code temporel associé à la demande de création de cluster.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
state

enum (State)

Uniquement en sortie. État actuel de ce cluster. Les états possibles sont CREATING, READY, UPDATING, DELETING et SUSPENDED.
uid

string

Uniquement en sortie. Identifiant unique attribué par le système pour le cluster.
authorizationMode

enum (AuthorizationMode)

Facultatif. Mode d'autorisation du cluster Redis. Si aucune valeur n'est fournie, la fonctionnalité d'authentification est désactivée pour le cluster.
transitEncryptionMode

enum (TransitEncryptionMode)

Facultatif. Chiffrement en transit pour le cluster Redis. Si aucune valeur n'est fournie, le chiffrement est désactivé pour le cluster.
pscConfigs[]

object (PscConfig)

Facultatif. Chaque PscConfig configure le réseau consommateur où les adresses IP seront attribuées au cluster pour l'accès client via l'automatisation Private Service Connect. Pour le moment, une seule configuration PscConfig est acceptée.
discoveryEndpoints[]

object (DiscoveryEndpoint)

Uniquement en sortie. Points de terminaison créés sur chaque réseau donné, permettant aux clients Redis de se connecter au cluster. Pour le moment, un seul point de terminaison de découverte est accepté.
pscConnections[]

object (PscConnection)

Uniquement en sortie. Liste des connexions PSC créées automatiquement grâce à l'automatisation de la connectivité des services.
stateInfo

object (StateInfo)

Uniquement en sortie. Informations supplémentaires sur l'état actuel du cluster.
nodeType

enum (NodeType)

Facultatif. Type de nœud Redis dans le cluster. NodeType détermine le type de machine sous-jacent d'un nœud Redis.
persistenceConfig

object (ClusterPersistenceConfig)

Facultatif. Configuration de la persistance (RDB, AOF) pour le cluster.
redisConfigs

map (key: string, value: string)

Facultatif. Paires clé/valeur des remplacements client pour les configurations Redis modifiables

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
zoneDistributionConfig

object (ZoneDistributionConfig)

Facultatif. Cette configuration sera utilisée pour déterminer comment le client souhaite que nous distribuions les ressources du cluster dans la région.
crossClusterReplicationConfig

object (CrossClusterReplicationConfig)

Facultatif. Configuration de la réplication entre clusters.
pscServiceAttachments[]

object (PscServiceAttachment)

Uniquement en sortie. Détails du rattachement de service pour configurer les connexions PSC
clusterEndpoints[]

object (ClusterEndpoint)

Facultatif. Liste des points de terminaison du cluster.
automatedBackupConfig

object (AutomatedBackupConfig)

Facultatif. Configuration de la sauvegarde automatique pour le cluster.
encryptionInfo

object (EncryptionInfo)

Uniquement en sortie. Informations sur le chiffrement des données au repos du cluster.
availableMaintenanceVersions[]

string

Uniquement en sortie. Ce champ permet de déterminer les versions de maintenance disponibles pour la mise à jour en libre-service.
allowFewerZonesDeployment
(deprecated)

boolean

Facultatif. Immuable. Obsolète, ne pas utiliser.
labels

map (key: string, value: string)

Facultatif. Libellés permettant de représenter les métadonnées fournies par l'utilisateur.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
aclPolicy

string

Facultatif. Règle de la LCA à appliquer au cluster.
Champ d'union import_sources. Source à partir de laquelle importer les données. import_sources ne peut être qu'un des éléments suivants :
gcsSource

object (GcsBackupSource)

Facultatif. Sauvegardes stockées dans des buckets Cloud Storage. Les buckets Cloud Storage doivent se trouver dans la même région que les clusters. L'autorisation de lecture est requise pour importer des données à partir des objets Cloud Storage fournis.
managedBackupSource

object (ManagedBackupSource)

Facultatif. Sauvegardes générées et gérées par le service Memorystore.

Champ d'union _replica_count.

_replica_count ne peut être qu'un des éléments suivants :
replicaCount

integer

Facultatif. Nombre de nœuds répliqués par segment.

Champ d'union _size_gb.

_size_gb ne peut être qu'un des éléments suivants :
sizeGb

integer

Uniquement en sortie. Taille de la mémoire Redis en Go pour l'ensemble du cluster, arrondie à l'entier supérieur.

Champ d'union _shard_count.

_shard_count ne peut être qu'un des éléments suivants :
shardCount

integer

Facultatif. Nombre de partitions pour le cluster Redis.

Champ d'union _precise_size_gb.

_precise_size_gb ne peut être qu'un des éléments suivants :
preciseSizeGb

number

Uniquement en sortie. Valeur précise de la taille de la mémoire Redis en Go pour l'ensemble du cluster.

Champ d'union _deletion_protection_enabled.

_deletion_protection_enabled ne peut être qu'un des éléments suivants :
deletionProtectionEnabled

boolean

Facultatif. L'opération de suppression échouera lorsque la valeur sera définie sur "true".

Champ d'union _maintenance_policy.

_maintenance_policy ne peut être qu'un des éléments suivants :
maintenancePolicy

object (ClusterMaintenancePolicy)

Facultatif. ClusterMaintenancePolicy détermine quand autoriser ou refuser les mises à jour.

Champ d'union _maintenance_schedule.

_maintenance_schedule ne peut être qu'un des éléments suivants :
maintenanceSchedule

object (ClusterMaintenanceSchedule)

Uniquement en sortie. ClusterMaintenanceSchedule Uniquement en sortie Planning de maintenance publié.

Champ d'union _satisfies_pzs.

_satisfies_pzs ne peut être qu'un des éléments suivants :
satisfiesPzs

boolean

Facultatif. Uniquement en sortie. Réservé pour une utilisation ultérieure.

Champ d'union _satisfies_pzi.

_satisfies_pzi ne peut être qu'un des éléments suivants :
satisfiesPzi

boolean

Facultatif. Uniquement en sortie. Réservé pour une utilisation ultérieure.

Champ d'union _simulate_maintenance_event.

_simulate_maintenance_event ne peut être qu'un des éléments suivants :
simulateMaintenanceEvent

boolean

Facultatif. Uniquement en entrée. Simulez un événement de maintenance.

Champ d'union _backup_collection.

_backup_collection ne peut être qu'un des éléments suivants :
backupCollection

string

Facultatif. Uniquement en sortie. Nom complet de la ressource de la collection de sauvegardes. Exemple : projects/{project}/locations/{location}/backupCollections/{collection}

Champ d'union _kms_key.

_kms_key ne peut être qu'un des éléments suivants :
kmsKey

string

Facultatif. Clé KMS utilisée pour chiffrer les données au repos du cluster.

Champ d'union _ondemand_maintenance.

_ondemand_maintenance ne peut être qu'un des éléments suivants :
ondemandMaintenance
(deprecated)

boolean

Facultatif. Uniquement en entrée. Maintenance à la demande pour le cluster. Ce champ peut être utilisé pour déclencher une mise à jour critique à la demande sur le cluster.

Champ d'union _async_cluster_endpoints_deletion_enabled.

_async_cluster_endpoints_deletion_enabled ne peut être qu'un des éléments suivants :
asyncClusterEndpointsDeletionEnabled

boolean

Facultatif. Si la valeur est "true", les points de terminaison de cluster créés et enregistrés par les clients peuvent être supprimés de manière asynchrone. En d'autres termes, un tel point de terminaison de cluster peut être désenregistré avant la suppression des règles de transfert dans le point de terminaison de cluster.

Champ d'union _maintenance_version.

_maintenance_version ne peut être qu'un des éléments suivants :
maintenanceVersion

string

Facultatif. Ce champ peut être utilisé pour déclencher une mise à jour en libre-service afin d'indiquer la version de maintenance souhaitée. L'entrée de ce champ peut être déterminée par le champ "available_maintenance_versions".

Champ d'union _effective_maintenance_version.

_effective_maintenance_version ne peut être qu'un des éléments suivants :
effectiveMaintenanceVersion

string

Uniquement en sortie. Ce champ représente la version de maintenance réelle du cluster.

Champ d'union _server_ca_mode.

_server_ca_mode ne peut être qu'un des éléments suivants :
serverCaMode

enum (ServerCaMode)

Facultatif. Mode CA du serveur pour le cluster.

Champ d'union _server_ca_pool.

_server_ca_pool ne peut être qu'un des éléments suivants :
serverCaPool

string

Facultatif. Pool d'autorités de certification géré par le client pour le cluster. Cela ne s'applique qu'à BYOCA, c'est-à-dire si server_ca_mode est défini sur SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA. Format : "projects/{project}/locations/{region}/caPools/{ca_pool}".

Champ d'union _rotate_server_certificate.

_rotate_server_certificate ne peut être qu'un des éléments suivants :
rotateServerCertificate

boolean

Facultatif. Uniquement en entrée. Effectuez une rotation des certificats de serveur.

Champ d'union _acl_policy_in_sync.

_acl_policy_in_sync ne peut être qu'un des éléments suivants :
aclPolicyInSync

boolean

Facultatif. Uniquement en sortie. Indique si les règles ACL appliquées au cluster sont synchronisées avec les dernières règles du règlement ACL. Ce champ ne s'applique que si la règle LCA est définie pour le cluster.

GcsBackupSource

Représentation JSON 
{
  "uris": [
    string
  ]
}
Champs
uris[]

string

Facultatif. URI des objets Cloud Storage à importer. Exemple : gs://bucket1/object1, gs://bucket2/folder2/object2

ManagedBackupSource

Représentation JSON 
{
  "backup": string
}
Champs
backup

string

Facultatif. Exemple : //redis.googleapis.com/projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup} Une version plus courte (sans le préfixe) du nom de la sauvegarde est également acceptée, comme projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup_id}. Dans ce cas, la sauvegarde est supposée se trouver sous redis.googleapis.com.

Horodatage

Représentation JSON 
{
  "seconds": string,
  "nanos": integer
}
Champs
seconds

string (int64 format)

Représente les secondes de l'heure UTC à partir de l'epoch Unix 1970-01-01T00:00:00Z. La valeur doit être comprise entre -62135596800 et 253402300799 inclus (ce qui correspond à 0001-01-01T00:00:00Z et 9999-12-31T23:59:59Z).
nanos

integer

Fractions de secondes non négatives avec une précision de l'ordre de la nanoseconde. Ce champ correspond à la partie en nanosecondes de la durée, et non à une alternative aux secondes. Les valeurs de secondes négatives avec des fractions doivent toujours comporter des valeurs de nanosecondes non négatives comptabilisées dans le temps. La valeur doit être comprise entre 0 et 999 999 999 inclus.

PscConfig

Représentation JSON 
{
  "network": string
}
Champs
network

string

Obligatoire. Réseau dans lequel l'adresse IP du point de terminaison de découverte sera réservée, au format projects/{network_project}/global/networks/{network_id}.

DiscoveryEndpoint

Représentation JSON 
{
  "address": string,
  "port": integer,
  "pscConfig": {
    object (PscConfig)
  }
}
Champs
address

string

Uniquement en sortie. Adresse du point de terminaison Redis exposé utilisé par les clients pour se connecter au service. L'adresse peut être une adresse IP ou un nom d'hôte.
port

integer

Uniquement en sortie. Numéro de port du point de terminaison Redis exposé.
pscConfig

object (PscConfig)

Uniquement en sortie. Configuration client pour l'emplacement où le point de terminaison est créé et à partir duquel il est accessible.

PscConnection

Représentation 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.
}
Champs
pscConnectionId

string

Obligatoire. ID de connexion PSC de la règle de transfert associée au rattachement de service.
address

string

Obligatoire. Adresse IP allouée sur le réseau consommateur pour la règle de transfert PSC.
forwardingRule

string

Obligatoire. URI de la règle de transfert côté consommateur. Exemple : projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}.
projectId

string

Facultatif. ID du projet consommateur dans lequel la règle de transfert est créée.
network

string

Obligatoire. Réseau consommateur dans lequel réside l'adresse IP, au format projects/{project_id}/global/networks/{network_id}.
serviceAttachment

string

Obligatoire. Rattachement de service qui est la cible de la connexion PSC, au format projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}.
pscConnectionStatus

enum (PscConnectionStatus)

Uniquement en sortie. État de la connexion PSC. Notez que cette valeur est mise à jour régulièrement. Pour obtenir le dernier état d'une connexion PSC, consultez https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details.
connectionType

enum (ConnectionType)

Uniquement en sortie. Type de connexion PSC.
Champ d'union ports. Numéro de port du point de terminaison de découverte exposé. ports ne peut être qu'un des éléments suivants :
port

integer

Uniquement en sortie. Le port ne sera défini que pour le point de terminaison principal/lecteur ou de découverte.

StateInfo

Représentation JSON 
{

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

Champ d'union info.

info ne peut être qu'un des éléments suivants :
updateInfo

object (UpdateInfo)

Décrit la mise à jour en cours sur le cluster lorsque l'état du cluster est UPDATING.

UpdateInfo

Représentation 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.
}
Champs

Champ d'union _target_shard_count.

_target_shard_count ne peut être qu'un des éléments suivants :
targetShardCount

integer

Nombre cible de segments pour le cluster Redis

Champ d'union _target_replica_count.

_target_replica_count ne peut être qu'un des éléments suivants :
targetReplicaCount

integer

Nombre cible de nœuds d'instances répliquées par segment.

Champ d'union _target_node_type.

_target_node_type ne peut être qu'un des éléments suivants :
targetNodeType

enum (NodeType)

Type de nœud cible pour le cluster Redis.

ClusterPersistenceConfig

Représentation JSON 
{
  "mode": enum (PersistenceMode),
  "rdbConfig": {
    object (RDBConfig)
  },
  "aofConfig": {
    object (AOFConfig)
  }
}
Champs
mode

enum (PersistenceMode)

Facultatif. Mode de persistance.
rdbConfig

object (RDBConfig)

Facultatif. Configuration RDB. Ce champ sera ignoré si le mode n'est pas RDB.
aofConfig

object (AOFConfig)

Facultatif. Configuration AOF. Ce champ sera ignoré si le mode n'est pas AOF.

RDBConfig

Représentation JSON 
{
  "rdbSnapshotPeriod": enum (SnapshotPeriod),
  "rdbSnapshotStartTime": string
}
Champs
rdbSnapshotPeriod

enum (SnapshotPeriod)

Facultatif. Période entre les instantanés RDB.
rdbSnapshotStartTime

string (Timestamp format)

Facultatif. Heure à laquelle le premier instantané a été ou sera tenté, et à laquelle les futurs instantanés seront alignés. Si elle n'est pas fournie, l'heure actuelle est utilisée.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

AOFConfig

Représentation JSON 
{
  "appendFsync": enum (AppendFsync)
}
Champs
appendFsync

enum (AppendFsync)

Facultatif. Configuration fsync.

RedisConfigsEntry

Représentation JSON 
{
  "key": string,
  "value": string
}
Champs
key

string
value

string

ZoneDistributionConfig

Représentation JSON 
{
  "mode": enum (ZoneDistributionMode),
  "zone": string
}
Champs
mode

enum (ZoneDistributionMode)

Facultatif. Mode de distribution des zones. En l'absence de spécification, la valeur par défaut est MULTI_ZONE.
zone

string

Facultatif. Lorsque la distribution "SINGLE ZONE" (ZONE UNIQUE) est sélectionnée, le champ de zone est utilisé pour allouer toutes les ressources dans cette zone. Cela ne s'applique pas à MULTI_ZONE et serait ignoré pour les clusters MULTI_ZONE.

CrossClusterReplicationConfig

Représentation JSON 
{
  "clusterRole": enum (ClusterRole),
  "primaryCluster": {
    object (RemoteCluster)
  },
  "secondaryClusters": [
    {
      object (RemoteCluster)
    }
  ],
  "updateTime": string,
  "membership": {
    object (Membership)
  }
}
Champs
clusterRole

enum (ClusterRole)

Uniquement en sortie. Rôle du cluster dans la réplication entre clusters.
primaryCluster

object (RemoteCluster)

Détails du cluster principal utilisé comme source de réplication pour ce cluster secondaire.

Ce champ n'est défini que pour un cluster secondaire.
secondaryClusters[]

object (RemoteCluster)

Liste des clusters secondaires qui répliquent ce cluster principal.

Ce champ n'est défini que pour un cluster principal.
updateTime

string (Timestamp format)

Uniquement en sortie. Heure de la dernière mise à jour de la configuration de la réplication entre clusters.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
membership

object (Membership)

Uniquement en sortie. Vue en sortie seule de tous les clusters membres participant à la réplication cross-cluster. Cette vue sera fournie par chaque cluster membre, quel que soit son rôle(principal ou secondaire).

Un cluster principal peut fournir des informations sur tous les clusters secondaires qui répliquent à partir de lui. Toutefois, un cluster secondaire ne connaît que le cluster principal à partir duquel il effectue la réplication. Toutefois, dans les scénarios où le cluster principal n'est pas disponible(par exemple, en cas d'indisponibilité régionale), une requête GetCluster peut être envoyée à n'importe quel autre cluster membre. Ce champ listera tous les clusters membres participant à la réplication cross-cluster.

RemoteCluster

Représentation JSON 
{
  "cluster": string,
  "uid": string
}
Champs
cluster

string

Uniquement en sortie. Chemin d'accès complet à la ressource du cluster distant au format suivant : projects//locations//clusters/
uid

string

Uniquement en sortie. Identifiant unique du cluster distant.

Abonnement

Représentation JSON 
{
  "primaryCluster": {
    object (RemoteCluster)
  },
  "secondaryClusters": [
    {
      object (RemoteCluster)
    }
  ]
}
Champs
primaryCluster

object (RemoteCluster)

Uniquement en sortie. Cluster principal servant de source de réplication pour les clusters secondaires.
secondaryClusters[]

object (RemoteCluster)

Uniquement en sortie. Liste des clusters secondaires qui répliquent le cluster principal.

ClusterMaintenancePolicy

Représentation JSON 
{
  "createTime": string,
  "updateTime": string,
  "weeklyMaintenanceWindow": [
    {
      object (ClusterWeeklyMaintenanceWindow)
    }
  ]
}
Champs
createTime

string (Timestamp format)

Uniquement en sortie. Date et heure de création de la règle (période de maintenance ou période de refus).

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle la règle (intervalle de maintenance ou période de refus) a été mise à jour.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
weeklyMaintenanceWindow[]

object (ClusterWeeklyMaintenanceWindow)

Facultatif. Intervalle de maintenance appliqué aux ressources couvertes par cette règle. Minimum : 1. Pour la version actuelle, le nombre maximal de weekly_maintenance_window doit être égal à 1.

ClusterWeeklyMaintenanceWindow

Représentation JSON 
{
  "day": enum (google.type.DayOfWeek),
  "startTime": {
    object (TimeOfDay)
  }
}
Champs
day

enum (google.type.DayOfWeek)

Facultatif. Permet de définir une programmation qui s'exécute un jour spécifique de la semaine.
startTime

object (TimeOfDay)

Facultatif. Heure de début de la période en UTC.

TimeOfDay

Représentation JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Champs
hours

integer

Heures de la journée au format 24 heures. Doit être supérieur ou égal à 0 et généralement inférieur ou égal à 23. Une API peut choisir d'autoriser la valeur "24:00:00" pour des cas tels que l'heure de fermeture des bureaux.
minutes

integer

Minutes d'une heure. Doit être supérieur ou égal à 0 et inférieur ou égal à 59.
seconds

integer

Secondes d'une minute. Doit être supérieur ou égal à 0 et généralement inférieur ou égal à 59. Une API peut autoriser la valeur 60 si elle autorise les secondes intercalaires.
nanos

integer

Fractions de secondes, en nanosecondes. La valeur doit être supérieure ou égale à 0 et inférieure ou égale à 999 999 999.

ClusterMaintenanceSchedule

Représentation JSON 
{
  "startTime": string,
  "endTime": string
}
Champs
startTime

string (Timestamp format)

Uniquement en sortie. Heure de début de toutes les maintenances planifiées à venir pour cette instance.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Uniquement en sortie. Heure de fin de toutes les maintenances planifiées à venir pour cette instance.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

PscServiceAttachment

Représentation JSON 
{
  "serviceAttachment": string,
  "connectionType": enum (ConnectionType)
}
Champs
serviceAttachment

string

Uniquement en sortie. URI du rattachement de service que votre PscConnection créé par vous-même doit utiliser comme cible
connectionType

enum (ConnectionType)

Uniquement en sortie. Type de connexion PSC ciblant ce rattachement de service.

ClusterEndpoint

Représentation JSON 
{
  "connections": [
    {
      object (ConnectionDetail)
    }
  ]
}
Champs
connections[]

object (ConnectionDetail)

Obligatoire. Groupe de connexions PSC. Ils sont créés dans le même réseau VPC, un pour chaque rattachement de service du cluster.

ConnectionDetail

Représentation 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.
}
Champs
Champ d'union connection. Une connexion PSC à un cluster peut être créée par le biais de l'automatisation de la connectivité des services (connexion enregistrée automatiquement) lors de la création du cluster, ou par le client lui-même (connexion enregistrée par l'utilisateur). connection ne peut être qu'un des éléments suivants :
pscAutoConnection

object (PscAutoConnection)

Informations détaillées sur une connexion PSC créée via l'automatisation de la connectivité des services.
pscConnection

object (PscConnection)

Informations détaillées sur une connexion PSC créée par le client propriétaire du cluster.

PscAutoConnection

Représentation JSON 
{
  "pscConnectionId": string,
  "address": string,
  "forwardingRule": string,
  "projectId": string,
  "network": string,
  "serviceAttachment": string,
  "pscConnectionStatus": enum (PscConnectionStatus),
  "connectionType": enum (ConnectionType)
}
Champs
pscConnectionId

string

Uniquement en sortie. ID de connexion PSC de la règle de transfert associée au rattachement de service.
address

string

Uniquement en sortie. Adresse IP allouée sur le réseau consommateur pour la règle de transfert PSC.
forwardingRule

string

Uniquement en sortie. URI de la règle de transfert côté consommateur. Exemple : projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}.
projectId

string

Obligatoire. ID du projet client à partir duquel la règle de transfert est créée.
network

string

Obligatoire. Réseau consommateur dans lequel réside l'adresse IP, au format projects/{project_id}/global/networks/{network_id}.
serviceAttachment

string

Uniquement en sortie. Rattachement de service qui est la cible de la connexion PSC, au format projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}.
pscConnectionStatus

enum (PscConnectionStatus)

Uniquement en sortie. État de la connexion PSC. Notez que cette valeur est mise à jour régulièrement. Veuillez utiliser les API Private Service Connect pour connaître le dernier état.
connectionType

enum (ConnectionType)

Uniquement en sortie. Type de connexion PSC.

AutomatedBackupConfig

Représentation 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.
}
Champs
automatedBackupMode

enum (AutomatedBackupMode)

Facultatif. Mode de sauvegarde automatique. Si le mode est désactivé, les autres champs sont ignorés.
Champ d'union schedule. Planning des sauvegardes automatiques. schedule ne peut être qu'un des éléments suivants :
fixedFrequencySchedule

object (FixedFrequencySchedule)

Facultatif. Déclenchez des sauvegardes automatiques à une fréquence fixe.

Champ d'union _retention.

_retention ne peut être qu'un des éléments suivants :
retention

string (Duration format)

Facultatif. Durée de conservation des sauvegardes automatiques avant leur suppression. La valeur doit être comprise entre 1 et 365 jours. Si aucune valeur n'est spécifiée, la valeur par défaut est de 35 jours.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"

FixedFrequencySchedule

Représentation 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.
}
Champs

Champ d'union _start_time.

_start_time ne peut être qu'un des éléments suivants :
startTime

object (TimeOfDay)

Obligatoire. Heure de début de chaque sauvegarde automatique en UTC. Elle doit être définie au début d'une heure. Ce champ est obligatoire.

Durée

Représentation JSON 
{
  "seconds": string,
  "nanos": integer
}
Champs
seconds

string (int64 format)

Secondes signées de la période. La valeur doit être comprise entre -315 576 000 000 et +315 576 000 000 (inclus). Remarque : Ces limites sont calculées à partir de : 60 s/min * 60 min/h * 24 h/jour * 365,25 jours/an * 10 000 ans
nanos

integer

Fractions de secondes signées avec une précision de l'ordre de la nanoseconde pour la durée. Les durées inférieures à une seconde sont représentées par un champ seconds égal à 0 et un champ nanos positif ou négatif. Pour les durées d'une seconde ou plus, une valeur non nulle pour le champ nanos doit avoir le même signe que le champ seconds. La valeur doit être comprise entre -999 999 999 et +999 999 999 inclus.

EncryptionInfo

Représentation JSON 
{
  "encryptionType": enum (Type),
  "kmsKeyVersions": [
    string
  ],
  "kmsKeyPrimaryState": enum (KmsKeyState),
  "lastUpdateTime": string
}
Champs
encryptionType

enum (Type)

Uniquement en sortie. Type de chiffrement.
kmsKeyVersions[]

string

Uniquement en sortie. Versions de clé KMS utilisées pour protéger les données au repos.
kmsKeyPrimaryState

enum (KmsKeyState)

Uniquement en sortie. État de la version principale de la clé KMS perçu par le système. Ce champ n'est pas renseigné dans les sauvegardes.
lastUpdateTime

string (Timestamp format)

Uniquement en sortie. Date et heure de la dernière mise à jour des informations de chiffrement.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

LabelsEntry

Représentation JSON 
{
  "key": string,
  "value": string
}
Champs
key

string
value

string

Schéma de sortie

Cette ressource représente une opération de longue durée résultant d'un appel d'API réseau.

Opération

Représentation 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.
}
Champs
name

string

Nom attribué par le serveur. Unique au sein du service qui le renvoie initialement. Si vous utilisez le mappage HTTP par défaut, le champ name doit être un nom de ressource se terminant par operations/{unique_id}.
metadata

object

{

createTime : heure de création de l'opération.

endTime : heure à laquelle l'exécution de l'opération s'est terminée.

target : chemin d'accès à la ressource défini par le serveur pour la cible de l'opération.

verb : nom du verbe exécuté par l'opération.

statusDetail : état de l'opération lisible par l'utilisateur, le cas échéant.

cancelRequested : indique si l'utilisateur a demandé l'annulation de l'opération. Les opérations qui ont bien été annulées possèdent la valeur Operation.error avec un code d'état google.rpc.Status.code de 1, correspondant au code Code.CANCELLED.

apiVersion : version de l'API utilisée pour démarrer l'opération.

}

Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.
done

boolean

Si la valeur est false, cela signifie que l'opération est toujours en cours. Si elle est définie sur true, l'opération est terminée, et un message error ou response est disponible.
Champ d'union result. Résultat de l'opération, qui peut être une erreur (message error) ou une réponse valide (message response). Si done == false, ni error, ni response ne sont définis. Si done == true, une seule des options error ou response peut être définie. Certains services peuvent ne pas fournir le résultat. result ne peut être qu'un des éléments suivants :
error

object (Status)

Résultat d'erreur de l'opération en cas d'échec ou d'annulation.
response

object

Réponse normale indiquant la réussite de l'opération. Si la méthode d'origine ne renvoie aucune donnée en cas de réussite (telle que Delete), la réponse est google.protobuf.Empty. Si la méthode d'origine est une méthode Get/Create/Update standard, la réponse doit correspondre à la ressource. Pour les autres méthodes, la réponse doit avoir le type XxxResponse, où Xxx est le nom de la méthode d'origine. Par exemple, si le nom de la méthode d'origine est TakeSnapshot(), le type de réponse déduit est TakeSnapshotResponse.

Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.

Tous

Représentation JSON 
{
  "typeUrl": string,
  "value": string
}
Champs
typeUrl

string

Identifie le type du message Protobuf sérialisé avec une référence URI composée d'un préfixe se terminant par une barre oblique et du nom de type complet.

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

Cette chaîne doit contenir au moins un caractère /. Le contenu après le dernier / doit être le nom complet du type sous forme canonique, sans point au début. N'écrivez pas de schéma sur ces références d'URI afin que les clients ne tentent pas de les contacter.

Le préfixe est arbitraire et les implémentations Protobuf sont censées supprimer tout ce qui précède le dernier / (inclus) pour identifier le type. type.googleapis.com/ est un préfixe par défaut courant que certaines anciennes implémentations requièrent. Ce préfixe n'indique pas l'origine du type, et les URI qui le contiennent ne sont pas censés répondre aux requêtes.

Toutes les chaînes d'URL de type doivent être des références URI légales avec la restriction supplémentaire (pour le format texte) que le contenu de la référence ne doit être composé que de caractères alphanumériques, d'échappements encodés en pourcentage et de caractères de l'ensemble suivant (sans les accents graves extérieurs) : /-.~_!$&()*+,;=. Bien que nous autorisions les encodages en pourcentage, les implémentations ne doivent pas les décoder pour éviter toute confusion avec les analyseurs existants. Par exemple, type.googleapis.com%2FFoo doit être rejeté.

Dans la conception d'origine de Any, la possibilité de lancer un service de résolution de type à ces URL de type a été envisagée, mais Protobuf n'en a jamais implémenté et considère que contacter ces URL est problématique et constitue un risque potentiel pour la sécurité. N'essayez pas de contacter les URL de type.
value

string (bytes format)

Contient une sérialisation Protobuf du type décrit par type_url.

Chaîne encodée en base64.

État

Représentation JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Champs
code

integer

Code d'état, qui doit être une valeur d'énumération de google.rpc.Code.
message

string

Message d'erreur destiné au développeur, qui doit être en anglais. Tout message d'erreur destiné aux utilisateurs doit être localisé et envoyé dans le champ google.rpc.Status.details, ou localisé par le client.
details[]

object

Liste de messages comportant les détails de l'erreur. Il existe un ensemble commun de types de message utilisable par les API.

Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.

Annotations d'outils

Indication de destruction : ❌ | Indication d'idempotence : ❌ | Indication de lecture seule : ❌ | Indication de monde ouvert : ❌