REST Resource: projects.locations.clusters

Ressource : Cluster

Instance de 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,
  "aclPolicyInfo": {
    object (AclPolicyInfo)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "gcsSource": {
    object (GcsBackupSource)
  },
  "managedBackupSource": {
    object (ManagedBackupSource)
  }
  // End of mutually exclusive fields.
  "replicaCount": integer,
  "sizeGb": integer,
  "shardCount": integer,
  "preciseSizeGb": number,
  "deletionProtectionEnabled": boolean,
  "maintenancePolicy": {
    object (ClusterMaintenancePolicy)
  },
  "maintenanceSchedule": {
    object (ClusterMaintenanceSchedule)
  },
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean,
  "simulateMaintenanceEvent": boolean,
  "backupCollection": string,
  "kmsKey": string,
  "ondemandMaintenance": boolean,
  "asyncClusterEndpointsDeletionEnabled": boolean,
  "maintenanceVersion": string,
  "effectiveMaintenanceVersion": string,
  "serverCaMode": enum (ServerCaMode),
  "serverCaPool": string,
  "rotateServerCertificate": boolean,
  "aclPolicyInSync": boolean
}
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/{projectId}/locations/{locationId}/clusters/{clusterId}

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 PscConfig est acceptée.

discoveryEndpoints[]

object (DiscoveryEndpoint)

Uniquement en sortie. Points de terminaison créés sur chaque réseau donné, pour que les clients Redis se connectent au cluster. Actuellement, 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 représentant 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.

aclPolicyInfo

object (AclPolicyInfo)

Uniquement en sortie. Détails de la règle LCA appliquée.

Source à partir de laquelle importer les données. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
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.

Fin des champs qui s'excluent mutuellement.
replicaCount

integer

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

sizeGb

integer

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

shardCount

integer

Facultatif. Nombre de segments pour le cluster Redis.

preciseSizeGb

number

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

deletionProtectionEnabled

boolean

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

maintenancePolicy

object (ClusterMaintenancePolicy)

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

maintenanceSchedule

object (ClusterMaintenanceSchedule)

Uniquement en sortie. ClusterMaintenanceSchedule Sortie uniquement. Calendrier de maintenance publié.

satisfiesPzs

boolean

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

satisfiesPzi

boolean

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

simulateMaintenanceEvent

boolean

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

backupCollection

string

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

kmsKey

string

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

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.

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. Autrement dit, 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.

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

effectiveMaintenanceVersion

string

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

serverCaMode

enum (ServerCaMode)

Facultatif. Mode CA du serveur pour le cluster.

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 serverCaMode est SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA. Format : "projects/{project}/locations/{region}/caPools/{ca_pool}".

rotateServerCertificate

boolean

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

aclPolicyInSync
(deprecated)

boolean

Facultatif. Uniquement en sortie. Obsolète : indique si les règles de la LCA appliquées au cluster sont synchronisées.

GcsBackupSource

Sauvegardes stockées dans des buckets Cloud Storage. Les buckets Cloud Storage doivent se trouver dans la même région que les clusters.

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

string

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

ManagedBackupSource

Sauvegardes générées et gérées par Memorystore.

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/{backupId}. Dans ce cas, la sauvegarde est supposée se trouver sous redis.googleapis.com.

État

Représente les différents états d'un cluster Redis.

Enums
STATE_UNSPECIFIED Non défini.
CREATING Création du cluster Redis…
ACTIVE Le cluster Redis a été créé et est entièrement utilisable.
UPDATING La configuration du cluster Redis est en cours de mise à jour.
DELETING Le cluster Redis est en cours de suppression.

AuthorizationMode

Mode d'autorisation disponible d'un cluster Redis.

Enums
AUTH_MODE_UNSPECIFIED Non défini.
AUTH_MODE_IAM_AUTH Mode d'autorisation IAM de base
AUTH_MODE_DISABLED Mode d'autorisation désactivé
AUTH_MODE_TOKEN_AUTH Mode d'autorisation basé sur des jetons

TransitEncryptionMode

Mode de chiffrement en transit disponible.

Enums
TRANSIT_ENCRYPTION_MODE_UNSPECIFIED Le chiffrement en transit n'est pas défini.
TRANSIT_ENCRYPTION_MODE_DISABLED Le chiffrement en transit est désactivé.
TRANSIT_ENCRYPTION_MODE_SERVER_AUTHENTICATION Utilisez le chiffrement géré par le serveur pour le chiffrement en transit.

PscConfig

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

string

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

DiscoveryEndpoint

Points de terminaison sur chaque réseau, permettant aux clients Redis de se connecter au cluster.

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

Détails des ressources du consommateur dans une connexion PSC.

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "port": integer
  // End of mutually exclusive fields.
}
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 client 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/{projectId}/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. Veuillez noter 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.

Numéro de port du point de terminaison de découverte exposé. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
port

integer

Sortie uniquement. Le port ne sera défini que pour le point de terminaison principal/lecteur ou de découverte.

Fin des champs qui s'excluent mutuellement.

PscConnectionStatus

État de la connexion PSC.

Enums
PSC_CONNECTION_STATUS_UNSPECIFIED L'état de la connexion PSC n'est pas spécifié.
PSC_CONNECTION_STATUS_ACTIVE La connexion est active
PSC_CONNECTION_STATUS_NOT_FOUND Connexion introuvable

ConnectionType

Type de connexion PSC, pour l'accès au cluster.

Enums
CONNECTION_TYPE_UNSPECIFIED Le type de point de terminaison du cluster n'est pas défini
CONNECTION_TYPE_DISCOVERY Point de terminaison du cluster qui sera utilisé pour la découverte de la topologie du cluster.
CONNECTION_TYPE_PRIMARY Point de terminaison du cluster qui sera utilisé comme point de terminaison principal pour accéder au cluster principal.
CONNECTION_TYPE_READER Point de terminaison du cluster qui sera utilisé comme point de terminaison de lecteur pour accéder aux répliques.

StateInfo

Représente des informations supplémentaires sur l'état du cluster.

Représentation JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "updateInfo": {
    object (UpdateInfo)
  }
  // End of mutually exclusive fields.
}
Champs
Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
updateInfo

object (UpdateInfo)

Décrit la mise à jour en cours sur le cluster lorsque l'état du cluster est "EN COURS DE MISE À JOUR".

Fin des champs qui s'excluent mutuellement.

UpdateInfo

Représente des informations sur un cluster en cours de mise à jour.

Représentation JSON
{
  "targetShardCount": integer,
  "targetReplicaCount": integer,
  "targetNodeType": enum (NodeType)
}
Champs
targetShardCount

integer

Nombre cible de segments pour le cluster Redis

targetReplicaCount

integer

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

targetNodeType

enum (NodeType)

Type de nœud cible pour le cluster Redis.

ClusterPersistenceConfig

Configuration de la fonctionnalité de persistance.

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.

PersistenceMode

Modes de persistance disponibles.

Enums
PERSISTENCE_MODE_UNSPECIFIED Non défini.
DISABLED La persistance est désactivée et toutes les données d'instantané sont supprimées.
RDB La persistance basée sur RDB est activée.
AOF La persistance basée sur AOF est activée.

RDBConfig

Configuration de la persistance basée sur RDB.

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 aucune valeur n'est fournie, l'heure actuelle sera 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".

SnapshotPeriod

Périodes d'instantané disponibles.

Enums
SNAPSHOT_PERIOD_UNSPECIFIED Non défini.
ONE_HOUR Une heure.
SIX_HOURS Six heures.
TWELVE_HOURS 12 heures.
TWENTY_FOUR_HOURS Vingt-quatre heures.

AOFConfig

Configuration de la persistance basée sur AOF.

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

enum (AppendFsync)

Facultatif. Configuration fsync.

AppendFsync

Modes fsync disponibles.

Enums
APPEND_FSYNC_UNSPECIFIED Non défini. Valeur par défaut : EVERYSEC
NO Ne jamais effectuer de fsync. Normalement, Linux vide les données toutes les 30 secondes avec cette configuration, mais cela dépend du réglage exact du noyau.
EVERYSEC fsync toutes les secondes. Si la sauvegarde est suffisamment rapide, vous ne perdrez qu'une seconde de données en cas de sinistre.
ALWAYS fsync chaque fois que de nouvelles commandes d'écriture sont ajoutées au fichier AOF. Il offre la meilleure protection contre la perte de données, mais au détriment des performances.

ZoneDistributionConfig

Configuration de la distribution des zones pour l'allocation des ressources du cluster.

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

enum (ZoneDistributionMode)

Facultatif. Mode de répartition 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.

zones[]

string

Facultatif. Spécifiez les zones d'un cluster multizone dans lesquelles Redis Cluster alloue des ressources. Cette option ne s'applique pas aux clusters à zone unique.

ZoneDistributionMode

Définit différents modes de distribution des zones.

Enums
ZONE_DISTRIBUTION_MODE_UNSPECIFIED Non défini. Par défaut : MULTI_ZONE
MULTI_ZONE Répartissez toutes les ressources dans trois zones choisies au hasard dans la région.
SINGLE_ZONE Distribuez toutes les ressources dans une seule zone. Le champ "Zone" doit être spécifié lorsque ce mode est sélectionné.

CrossClusterReplicationConfig

Configuration de la réplication entre clusters.

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

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 effectuent une réplication à partir de 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 inter-clusters. 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 effectuent une réplication à partir de celui-ci. 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 clusters.get peut être envoyée à n'importe quel autre cluster membre. Ce champ listera tous les clusters membres participant à la réplication cross-cluster.

ClusterRole

Rôle du cluster dans la réplication multicluster.

Enums
CLUSTER_ROLE_UNSPECIFIED Le rôle de cluster n'est pas défini. Le comportement est équivalent à NONE.
NONE Ce cluster ne participe pas à la réplication inter-clusters. Il s'agit d'un cluster indépendant qui ne réplique pas les données vers ou depuis d'autres clusters.
PRIMARY Cluster qui permet les opérations de lecture et d'écriture. Toutes les données écrites dans ce cluster sont également répliquées dans les clusters secondaires associés.
SECONDARY Cluster qui autorise uniquement les lectures et réplique les données à partir d'un cluster principal.

RemoteCluster

Détails du cluster distant associé à ce cluster dans une configuration de réplication entre clusters.

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

Vue en sortie seule de tous les clusters membres participant à la réplication inter-clusters.

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

object (RemoteCluster)

Uniquement en sortie. Cluster principal qui sert de source de réplication pour les clusters secondaires.

secondaryClusters[]

object (RemoteCluster)

Uniquement en sortie. Liste des clusters secondaires qui répliquent à partir du cluster principal.

ClusterMaintenancePolicy

Règle de maintenance par cluster.

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

string (Timestamp format)

Uniquement en sortie. Heure à laquelle la règle (période de maintenance ou période de refus, par exemple) a été créée ou attribué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".

updateTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle la règle (intervalle de maintenance ou période de refus) a été modifié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".

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 weeklyMaintenanceWindow doit être de un.

ClusterWeeklyMaintenanceWindow

Plage horaire spécifiée pour les opérations hebdomadaires.

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

enum (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 au format UTC.

ClusterMaintenanceSchedule

Calendrier de maintenance à venir.

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 toute maintenance planifiée à 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

Configuration d'un rattachement de service du cluster pour créer des connexions PSC.

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

ClusterEndpoint se compose de connexions PSC créées en tant que groupe dans chaque réseau VPC pour accéder au cluster. Dans chaque groupe, il doit y avoir une connexion pour chaque rattachement de service du cluster.

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

Informations détaillées sur chaque connexion PSC.

Représentation JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "pscAutoConnection": {
    object (PscAutoConnection)
  },
  "pscConnection": {
    object (PscConnection)
  }
  // End of mutually exclusive fields.
}
Champs
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). Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
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.

Fin des champs qui s'excluent mutuellement.

PscAutoConnection

Détails des ressources client dans une connexion PSC créée via l'automatisation de la connectivité des services.

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/{projectId}/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. Veuillez noter 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

Configuration de la sauvegarde automatique pour un cluster.

Représentation JSON
{
  "automatedBackupMode": enum (AutomatedBackupMode),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "fixedFrequencySchedule": {
    object (FixedFrequencySchedule)
  }
  // End of mutually exclusive fields.
  "retention": string
}
Champs
automatedBackupMode

enum (AutomatedBackupMode)

Facultatif. Mode de sauvegarde automatique. Si le mode est désactivé, les autres champs seront ignorés.

Planning des sauvegardes automatiques. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
fixedFrequencySchedule

object (FixedFrequencySchedule)

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

Fin des champs qui s'excluent mutuellement.
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

Ce calendrier permet de déclencher la sauvegarde à une fréquence fixe (actuellement, seule la fréquence quotidienne est acceptée).

Représentation JSON
{
  "startTime": {
    object (TimeOfDay)
  }
}
Champs
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.

AutomatedBackupMode

Mode de sauvegarde automatique.

Enums
AUTOMATED_BACKUP_MODE_UNSPECIFIED Valeur par défaut. La configuration de la sauvegarde automatique n'est pas spécifiée.
DISABLED La configuration de la sauvegarde automatique est désactivée.
ENABLED La configuration de la sauvegarde automatique est activée.

ServerCaMode

Mode CA du serveur pour le cluster.

Enums
SERVER_CA_MODE_UNSPECIFIED Le mode CA du serveur n'est pas spécifié.
SERVER_CA_MODE_GOOGLE_MANAGED_PER_INSTANCE_CA Chaque cluster possède sa propre CA gérée par Google.
SERVER_CA_MODE_GOOGLE_MANAGED_SHARED_CA Le cluster utilise une autorité de certification partagée gérée par Google dans la région.
SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA Le cluster utilise l'autorité de certification gérée par le client à partir de CAS.

AclPolicyInfo

Détails de la règle LCA appliquée.

Représentation JSON
{
  "appliedAclPolicy": string,
  "appliedAclPolicyRevision": string,
  "appliedAclPolicyRevisionNumber": string,
  "aclPolicyRevisionStatuses": [
    {
      object (AclPolicyRevisionStatus)
    }
  ]
}
Champs
appliedAclPolicy

string

Uniquement en sortie. Nom de ressource de la stratégie LCA appliquée. Format : "projects/{project}/locations/{location}/aclPolicies/{aclPolicy}"

appliedAclPolicyRevision

string

Uniquement en sortie. Nom de ressource de la révision de la stratégie LCA appliquée. Format : "projects/{project}/locations/{location}/aclPolicies/{aclPolicy}/revisions/{revision}"

appliedAclPolicyRevisionNumber

string (int64 format)

Uniquement en sortie. Numéro de révision de la révision de la règle LCA appliquée.

aclPolicyRevisionStatuses[]

object (AclPolicyRevisionStatus)

Uniquement en sortie. Liste des états des différentes révisions de cette règle LCA sur le cluster.

Méthodes

addTokenAuthUser

Ajoute un utilisateur d'authentification par jeton pour un cluster sur lequel l'authentification par jeton est activée.

backup

Sauvegardez le cluster Redis.

create

Crée un cluster Redis en fonction des propriétés spécifiées.

delete

Supprime un cluster Redis spécifique.

get

Obtient les détails d'un cluster Redis spécifique.

getCertificateAuthority

Obtient les informations détaillées sur l'autorité de certification pour le cluster Redis.

list

Liste tous les clusters Redis appartenant à un projet, dans l'emplacement (région) spécifié ou dans tous les emplacements.

patch

Met à jour les métadonnées et la configuration d'un cluster Redis spécifique.

rescheduleClusterMaintenance

Reprogramme un événement de maintenance à venir.