REST Resource: projects.locations.instances

Ressource : Instance

Une instance Memorystore.

Représentation JSON 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "state": enum (State),
  "stateInfo": {
    object (StateInfo)
  },
  "uid": string,
  "authorizationMode": enum (AuthorizationMode),
  "transitEncryptionMode": enum (TransitEncryptionMode),
  "shardCount": integer,
  "discoveryEndpoints": [
    {
      object (DiscoveryEndpoint)
    }
  ],
  "nodeType": enum (NodeType),
  "persistenceConfig": {
    object (PersistenceConfig)
  },
  "engineVersion": string,
  "engineConfigs": {
    string: string,
    ...
  },
  "nodeConfig": {
    object (NodeConfig)
  },
  "zoneDistributionConfig": {
    object (ZoneDistributionConfig)
  },
  "pscAutoConnections": [
    {
      object (PscAutoConnection)
    }
  ],
  "pscAttachmentDetails": [
    {
      object (PscAttachmentDetail)
    }
  ],
  "endpoints": [
    {
      object (InstanceEndpoint)
    }
  ],
  "mode": enum (Mode),
  "maintenancePolicy": {
    object (MaintenancePolicy)
  },
  "maintenanceSchedule": {
    object (MaintenanceSchedule)
  },
  "crossInstanceReplicationConfig": {
    object (CrossInstanceReplicationConfig)
  },
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "automatedBackupConfig": {
    object (AutomatedBackupConfig)
  },
  "availableMaintenanceVersions": [
    string
  ],
  "allowFewerZonesDeployment": boolean,
  "migrationConfig": {
    object (MigrationConfig)
  },
  "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,
  "deletionProtectionEnabled": boolean,
  "simulateMaintenanceEvent": boolean,
  "ondemandMaintenance": boolean,
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean,
  "asyncInstanceEndpointsDeletionEnabled": boolean,
  "kmsKey": string,
  "backupCollection": string,
  "maintenanceVersion": string,
  "effectiveMaintenanceVersion": string,
  "serverCaMode": enum (ServerCaMode),
  "serverCaPool": string,
  "rotateServerCertificate": boolean,
  "aclPolicy": string,
  "aclPolicyInSync": boolean
}
Champs
name

string

Identifiant. Nom unique de l'instance. Format : projects/{project}/locations/{location}/instances/{instance}
createTime

string (Timestamp format)

Uniquement en sortie. Code temporel de création de l'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".
updateTime

string (Timestamp format)

Uniquement en sortie. Horodatage de la dernière mise à jour de l'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".
labels

map (key: string, value: string)

Facultatif. Étiquettes 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" }.
state

enum (State)

Uniquement en sortie. État actuel de l'instance.
stateInfo

object (StateInfo)

Uniquement en sortie. Informations supplémentaires sur l'état de l'instance.
uid

string

Uniquement en sortie. Identifiant unique attribué par le système pour l'instance.
authorizationMode

enum (AuthorizationMode)

Facultatif. Mode d'autorisation de l'instance.
transitEncryptionMode

enum (TransitEncryptionMode)

Facultatif. Immuable. Mode de chiffrement en transit de l'instance.
shardCount

integer

Facultatif. Nombre de segments pour l'instance.
discoveryEndpoints[]
(deprecated)

object (DiscoveryEndpoint)

Uniquement en sortie. Obsolète : le paramètre discoveryEndpoints est obsolète. Par conséquent, il ne sera pas renseigné si les connexions sont créées à l'aide du paramètre "endpoints". Pour la découverte, utilisez plutôt les paramètres endpoints.connections.pscConnection et endpoints.connections.pscAutoConnection avec connectionType CONNECTION_TYPE_DISCOVERY.
nodeType

enum (NodeType)

Facultatif. Type de machine pour les nœuds individuels de l'instance.
persistenceConfig

object (PersistenceConfig)

Facultatif. Configuration de la persistance de l'instance.
engineVersion

string

Facultatif. Version du moteur de l'instance.
engineConfigs

map (key: string, value: string)

Facultatif. Configurations du moteur fournies par l'utilisateur pour l'instance.

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

object (NodeConfig)

Uniquement en sortie. Configuration des nœuds individuels de l'instance.
zoneDistributionConfig

object (ZoneDistributionConfig)

Facultatif. Immuable. Configuration de la distribution des zones de l'instance pour l'allocation des nœuds.
pscAutoConnections[]
(deprecated)

object (PscAutoConnection)

Facultatif. Immuable. Obsolète : utilisez plutôt la valeur endpoints.connections.psc_auto_connection.
pscAttachmentDetails[]

object (PscAttachmentDetail)

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

object (InstanceEndpoint)

Facultatif. Points de terminaison de l'instance.
mode

enum (Mode)

Facultatif. Immuable. La configuration du mode pour l'instance.
maintenancePolicy

object (MaintenancePolicy)

Facultatif. Stratégie de maintenance de l'instance. Si aucune valeur n'est fournie, l'événement de maintenance sera effectué en fonction du calendrier de déploiement interne de Memorystore.
maintenanceSchedule

object (MaintenanceSchedule)

Uniquement en sortie. Calendrier de maintenance publié.
crossInstanceReplicationConfig

object (CrossInstanceReplicationConfig)

Facultatif. Configuration de la réplication entre instances.
encryptionInfo

object (EncryptionInfo)

Uniquement en sortie. Informations de chiffrement des données au repos du cluster.
automatedBackupConfig

object (AutomatedBackupConfig)

Facultatif. Configuration de la sauvegarde automatique pour l'instance.
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.
migrationConfig

object (MigrationConfig)

Uniquement en sortie. Configuration de la migration pour l'instance.
aclPolicyInfo

object (AclPolicyInfo)

Uniquement en sortie. Détails de la règle LCA appliquée.
Source à partir de laquelle effectuer l'importation. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
gcsSource

object (GcsBackupSource)

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

object (ManagedBackupSource)

Facultatif. Immuable. Sauvegardes générées et gérées par le service Memorystore.
Fin des champs mutuellement exclusifs.
replicaCount

integer

Facultatif. Nombre de nœuds d'instances répliquées par segment. Si aucune valeur n'est spécifiée, la valeur par défaut est de 0 instance répliquée.
deletionProtectionEnabled

boolean

Facultatif. Si la valeur est "true", la suppression de l'instance échoue.
simulateMaintenanceEvent

boolean

Facultatif. Uniquement en entrée. Simulez un événement de maintenance.
ondemandMaintenance
(deprecated)

boolean

Facultatif. Uniquement en entrée. Maintenance à la demande pour l'instance.
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.
asyncInstanceEndpointsDeletionEnabled

boolean

Facultatif. Si la valeur est "true", les points de terminaison d'instance créés et enregistrés par les clients peuvent être supprimés de manière asynchrone. Autrement dit, un tel point de terminaison d'instance peut être désenregistré avant que les règles de transfert qu'il contient ne soient supprimées.
kmsKey

string

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

string

Uniquement en sortie. Nom complet de la ressource de la collection de sauvegardes. Exemple : projects/{project}/locations/{location}/backupCollections/{collection}
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 de l'instance.
serverCaMode

enum (ServerCaMode)

Facultatif. Immuable. Mode CA du serveur pour l'instance.
serverCaPool

string

Facultatif. Immuable. Pool d'autorités de certification géré par le client pour l'instance. Cela ne s'applique que si le mode d'autorité de certification du serveur est 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.
aclPolicy

string

Facultatif. Stratégie LCA de l'instance. Format : projects/{project}/locations/{location}/aclPolicies/{aclPolicy}
aclPolicyInSync
(deprecated)

boolean

Uniquement en sortie. Obsolète : indique si les règles de LCA appliquées à l'instance 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 instances.

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

string

Facultatif. 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 : //memorystore.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, par exemple projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backupId}. Dans ce cas, elle suppose que la sauvegarde se trouve sous memorystore.googleapis.com.

État

États possibles de l'instance.

Enums
STATE_UNSPECIFIED Non défini.
CREATING Création de l'instance…
ACTIVE L'instance a été créée et est utilisable.
UPDATING Mise à jour de l'instance…
DELETING Suppression de l'instance…
MIGRATING L'instance est en cours de migration.

StateInfo

Informations supplémentaires sur l'état de l'instance.

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
Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
updateInfo

object (UpdateInfo)

Uniquement en sortie. Décrit la mise à jour en cours lorsque l'état de l'instance est "UPDATING".
Fin des champs mutuellement exclusifs.

UpdateInfo

Représente des informations sur l'instance dont l'état est "UPDATING".

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

integer

Uniquement en sortie. Nombre cible de segments pour l'instance.
targetReplicaCount

integer

Uniquement en sortie. Nombre cible de nœuds d'instances répliquées par segment pour l'instance.
targetEngineVersion

string

Uniquement en sortie. Version du moteur cible pour l'instance.
targetNodeType

enum (NodeType)

Uniquement en sortie. Type de nœud cible pour l'instance.

AuthorizationMode

Modes d'autorisation possibles de l'instance.

Enums
AUTHORIZATION_MODE_UNSPECIFIED Non défini.
AUTH_DISABLED Autorisation désactivée.
IAM_AUTH Autorisation IAM de base.
TOKEN_AUTH Autorisation basée sur un jeton.

TransitEncryptionMode

Modes de chiffrement en transit possibles de l'instance.

Enums
TRANSIT_ENCRYPTION_MODE_UNSPECIFIED Non défini.
TRANSIT_ENCRYPTION_DISABLED Le chiffrement en transit est désactivé.
SERVER_AUTHENTICATION Le chiffrement géré par le serveur est utilisé pour le chiffrement en transit.

DiscoveryEndpoint

Représente un point de terminaison permettant aux clients de se connecter à l'instance.

Représentation JSON 
{
  "address": string,
  "port": integer,
  "network": string
}
Champs
address

string

Uniquement en sortie. Adresse IP du point de terminaison exposé auquel les clients se connectent.
port

integer

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

string

Uniquement en sortie. 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_name}.

PersistenceConfig

Représente la configuration de persistance d'une instance.

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

enum (PersistenceMode)

Facultatif. Mode de persistance actuel.
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 possibles.

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 l'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é/sera tenté, et sur 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é possibles.

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 l'AOF.

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

enum (AppendFsync)

Facultatif. Mode fsync.

AppendFsync

Modes fsync possibles.

Enums
APPEND_FSYNC_UNSPECIFIED Non défini. Valeur par défaut : EVERY_SEC
NEVER Ne jamais utiliser fsync. Normalement, Linux vide les données toutes les 30 secondes avec cette configuration, mais cela dépend du réglage exact du noyau.
EVERY_SEC Fsync toutes les secondes. Vous risquez de perdre une seconde de données en cas de sinistre.
ALWAYS Fsync chaque fois que de nouvelles commandes d'écriture sont ajoutées à l'AOF. Meilleure protection contre la perte de données, au détriment des performances.

NodeConfig

Représente la configuration des nœuds de l'instance.

Représentation JSON 
{
  "sizeGb": number
}
Champs
sizeGb

number

Uniquement en sortie. Taille de la mémoire du nœud en Go.

ZoneDistributionConfig

Configuration de la distribution par zone pour l'allocation des ressources d'instance.

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

string

Facultatif. Définit la zone dans laquelle toutes les ressources seront allouées avec le mode SINGLE_ZONE. Ignoré pour le mode MULTI_ZONE.
zones[]

string

Facultatif. Spécifiez les zones d'une instance multizone dans lesquelles l'instance Memorystore alloue des ressources. Cette option ne s'applique pas aux instances monozones.
activeZones[]

string

Uniquement en sortie. Liste des zones dans lesquelles l'instance comporte des VM actives.
mode

enum (ZoneDistributionMode)

Facultatif. Mode de distribution de zone actuel. La valeur par défaut est MULTI_ZONE.

ZoneDistributionMode

Modes de distribution de zone possibles.

Enums
ZONE_DISTRIBUTION_MODE_UNSPECIFIED Non défini. Par défaut : MULTI_ZONE
MULTI_ZONE Répartissez les ressources sur trois zones choisies au hasard dans la région.
SINGLE_ZONE Provisionnez des ressources dans une seule zone. Le champ "Zone" doit être spécifié.

PscAutoConnection

Détails des ressources client dans une connexion PSC.

Représentation JSON 
{
  "pscConnectionId": string,
  "ipAddress": 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

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

string

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

string

Uniquement en sortie. URI de la règle de transfert côté consommateur. Format : projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
projectId

string

Obligatoire. ID du projet client dans lequel les connexions PSC sont établies. Il doit s'agir du même ID de projet que celui dans lequel l'instance est créée.
network

string

Obligatoire. Réseau dans lequel les points de terminaison PSC sont créés, au format projects/{projectId}/global/networks/{network_name}.
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 : indique si une connexion existe et est ACTIVE, ou si elle n'existe plus. Notez que cette valeur est mise à jour régulièrement. Veuillez utiliser les API Private Service Connect pour connaître l'état le plus récent.
connectionType

enum (ConnectionType)

Uniquement en sortie. Type de connexion PSC.
Ports du point de terminaison exposé. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
port

integer

Facultatif. Le port ne sera défini que pour le point de terminaison principal/lecteur ou de découverte.
Fin des champs mutuellement exclusifs.

PscConnectionStatus

État de la connexion PSC.

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

ConnectionType

Type d'une connexion PSC

Enums
CONNECTION_TYPE_UNSPECIFIED Le type de connexion n'est pas défini
CONNECTION_TYPE_DISCOVERY Connexion qui sera utilisée pour la découverte de la topologie.
CONNECTION_TYPE_PRIMARY Connexion qui sera utilisée comme point de terminaison principal pour accéder à l'instance principale.
CONNECTION_TYPE_READER Connexion qui sera utilisée comme point de terminaison de lecteur pour accéder aux instances dupliquées.

PscAttachmentDetail

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éée par vos soins doit utiliser comme cible.
connectionType

enum (ConnectionType)

Uniquement en sortie. Type de point de terminaison PSC.

InstanceEndpoint

InstanceEndpoint se compose de connexions PSC créées en tant que groupe dans chaque réseau VPC pour accéder à l'instance. 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)

Facultatif. Un groupe de connexions PSC. Elles sont créées dans le même réseau VPC, une pour chaque rattachement de service du cluster.

ConnectionDetail

Informations 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 à une instance peut être créée via l'automatisation de la connectivité des services (connexion automatique) lors de la création du cluster, ou par le client lui-même (connexion créée par l'utilisateur). Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
pscAutoConnection

object (PscAutoConnection)

Immuable. 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 l'utilisateur.
Fin des champs mutuellement exclusifs.

PscConnection

Configuration de connexion PSC créée par l'utilisateur.

Représentation JSON 
{
  "pscConnectionId": string,
  "ipAddress": 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 connectée au rattachement de service.
ipAddress

string

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

string

Obligatoire. URI de la règle de transfert côté consommateur. Format : projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
projectId

string

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

string

Obligatoire. Réseau client où réside l'adresse IP, au format projects/{projectId}/global/networks/{network_name}.
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 : indique si une connexion existe et est ACTIVE, ou si elle n'existe plus. Notez que cette valeur est mise à jour régulièrement. Veuillez utiliser les API Private Service Connect pour connaître l'état le plus récent.
connectionType

enum (ConnectionType)

Uniquement en sortie. Type de connexion PSC.
Ports du point de terminaison exposé. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
port

integer

Facultatif. Le port ne sera défini que pour le point de terminaison principal/lecteur ou de découverte.
Fin des champs mutuellement exclusifs.

Mode

La configuration du mode, qui permet d'activer ou de désactiver le mode cluster.

Enums
MODE_UNSPECIFIED Le mode n'est pas spécifié.
STANDALONE

Obsolète : utilisez CLUSTER_DISABLED à la place.
CLUSTER L'instance est en mode cluster.
CLUSTER_DISABLED Le mode cluster est désactivé pour l'instance.

MaintenancePolicy

Stratégie de maintenance par instance.

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

string (Timestamp format)

Uniquement en sortie. Heure de création de la règle.

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 stratégie 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 (WeeklyMaintenanceWindow)

Facultatif. Intervalle de maintenance appliqué aux ressources couvertes par cette règle. Minimum : 1. Pour la version actuelle, le nombre maximal de weekly_window est de un.

WeeklyMaintenanceWindow

Période spécifiée pour les opérations hebdomadaires.

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

enum (DayOfWeek)

Facultatif. Jour de la semaine de l'intervalle de maintenance. Ce champ est obligatoire. Vous ne pouvez pas utiliser DAY_OF_WEEK_UNSPECIFIED.
startTime

object (TimeOfDay)

Facultatif. Heure de début de l'intervalle de maintenance au format UTC. Lorsque vous spécifiez un intervalle de maintenance, startTime est obligatoire.

MaintenanceSchedule

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

CrossInstanceReplicationConfig

Configuration de la réplication entre instances.

Représentation JSON 
{
  "instanceRole": enum (InstanceRole),
  "primaryInstance": {
    object (RemoteInstance)
  },
  "secondaryInstances": [
    {
      object (RemoteInstance)
    }
  ],
  "updateTime": string,
  "membership": {
    object (Membership)
  }
}
Champs
instanceRole

enum (InstanceRole)

Obligatoire. Rôle de l'instance dans la réplication entre instances.
primaryInstance

object (RemoteInstance)

Facultatif. Détails de l'instance principale utilisée comme source de réplication pour cette instance secondaire.

Ce champ n'est défini que pour une instance secondaire.
secondaryInstances[]

object (RemoteInstance)

Facultatif. Liste des instances secondaires qui effectuent une réplication à partir de cette instance principale.

Ce champ n'est défini que pour une instance principale.
updateTime

string (Timestamp format)

Uniquement en sortie. Dernière mise à jour de la configuration de la réplication entre instances.

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 uniquement de toutes les instances membres participant à la réplication entre instances. Cette vue sera fournie par chaque instance membre, quel que soit son rôle (principale ou secondaire).

Une instance principale peut fournir des informations sur toutes les instances secondaires qui la répliquent. Toutefois, une instance secondaire ne connaît que l'instance principale à partir de laquelle elle effectue la réplication. Toutefois, dans les scénarios où l'instance principale n'est pas disponible (par exemple, en cas de panne régionale), une requête Getinstance peut être envoyée à n'importe quelle autre instance membre. Ce champ listera toutes les instances membres participant à la réplication entre instances.

InstanceRole

Rôle de l'instance dans la réplication entre instances.

Enums
INSTANCE_ROLE_UNSPECIFIED Le rôle de l'instance n'est pas défini. Le comportement est équivalent à NONE.
NONE Cette instance ne participe pas à la réplication entre instances. Il s'agit d'une instance indépendante qui ne réplique pas vers ou depuis d'autres instances.
PRIMARY Instance qui autorise à la fois les lectures et les écritures. Toutes les données écrites sur cette instance sont également répliquées sur les instances secondaires associées.
SECONDARY Instance qui n'autorise que les lectures et qui réplique les données d'une instance principale.

RemoteInstance

Détails de l'instance distante associée à cette instance dans une configuration de réplication entre instances.

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

string

Facultatif. Chemin d'accès complet de la ressource de l'instance distante au format : projects//locations//instances/
uid

string

Uniquement en sortie. Identifiant unique de l'instance distante.

Abonnement

Vue en sortie uniquement de toutes les instances membres participant à la réplication entre instances.

Représentation JSON 
{
  "primaryInstance": {
    object (RemoteInstance)
  },
  "secondaryInstances": [
    {
      object (RemoteInstance)
    }
  ]
}
Champs
primaryInstance

object (RemoteInstance)

Uniquement en sortie. L'instance principale qui sert de source de réplication pour les instances secondaires.
secondaryInstances[]

object (RemoteInstance)

Uniquement en sortie. Liste des instances secondaires répliquées à partir de l'instance principale.

AutomatedBackupConfig

Configuration de la sauvegarde automatique pour une instance.

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

  // 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.
}
Champs
automatedBackupMode

enum (AutomatedBackupMode)

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

string (Duration format)

Facultatif. Durée de conservation des sauvegardes automatiques avant leur suppression. La valeur doit être comprise entre 1 jour 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"
Planification des sauvegardes automatiques. Voici une liste de champs mutuellement exclusifs. Au maximum, un 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 mutuellement exclusifs.

FixedFrequencySchedule

Cette planification 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. Il doit être défini sur le 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 l'instance.

Enums
SERVER_CA_MODE_UNSPECIFIED Mode CA du serveur non spécifié.
GOOGLE_MANAGED_PER_INSTANCE_CA Chaque instance possède sa propre autorité de certification gérée par Google.
GOOGLE_MANAGED_SHARED_CA L'instance utilise une autorité de certification partagée gérée par Google pour la région de l'instance.
CUSTOMER_MANAGED_CAS_CA L'instance utilise une autorité de certification gérée par le client à partir de CAS.
SERVER_CA_MODE_GOOGLE_MANAGED_PER_INSTANCE_CA

Obsolète : utilisez GOOGLE_MANAGED_PER_INSTANCE_CA à la place.
SERVER_CA_MODE_GOOGLE_MANAGED_SHARED_CA

Obsolète : utilisez GOOGLE_MANAGED_SHARED_CA à la place.
SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA

Obsolète : utilisez CUSTOMER_MANAGED_CAS_CA à la place.

MigrationConfig

Configuration pour la migration d'une instance.

Représentation JSON 
{
  "state": enum (State),
  "forceFinishMigration": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "selfManagedSource": {
    object (SelfManagedSource)
  }
  // End of mutually exclusive fields.
}
Champs
state

enum (State)

Uniquement en sortie. État de migration de l'instance.
forceFinishMigration

boolean

Uniquement en sortie. Représente un indicateur booléen permettant de forcer la finalisation de la migration sans validation du rattrapage du décalage entre la source et la cible avant l'arrêt de la réplication.
Détails sur la source de migration. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
selfManagedSource

object (SelfManagedSource)

Uniquement en sortie. Configuration pour la migration depuis une instance Valkey/Redis autogérée
Fin des champs mutuellement exclusifs.

SelfManagedSource

Détails de l'instance source autogérée.

Représentation JSON 
{
  "ipAddress": string,
  "port": integer,
  "networkAttachment": string
}
Champs
ipAddress

string

Obligatoire. Adresse IP de l'instance source. Cette adresse IP doit être une adresse IP stable, accessible par l'instance Memorystore tout au long du processus de migration.
port

integer

Obligatoire. Port de l'instance source. Ce port doit être stable et accessible par l'instance Memorystore tout au long du processus de migration.
networkAttachment

string

Obligatoire. Nom de ressource du rattachement de réseau Private Service Connect utilisé pour établir la connectivité à l'instance source. Ce rattachement de réseau doit répondre aux exigences suivantes : 1. Il doit se trouver dans le même projet que l'instance Memorystore. 2. Il doit se trouver dans la même région que l'instance Memorystore. 3. Le sous-réseau associé au rattachement de réseau doit se trouver dans le même réseau VPC que les nœuds de l'instance source.

Format : projects/{project}/regions/{region}/networkAttachments/{networkAttachment}

État

État de migration de l'instance. De nouvelles valeurs pourront être ajoutées à l'avenir.

Enums
STATE_UNSPECIFIED L'instance n'a aucune activité liée à la migration. Il s'agit de l'état initial.
ROLLED_BACK L'instance n'est pas en cours de migration. L'instance a fait l'objet d'une tentative de migration qui a échoué, et le rollback ultérieur a réussi. L'instance est maintenant prête pour une nouvelle tentative de migration, si vous le souhaitez.
ROLLING_BACK Indique qu'une tentative de migration précédente a échoué. L'état de l'instance de haut niveau sera MIGRATING. L'instance n'est pas prête pour une nouvelle tentative de migration. Le rollback est en cours pour restaurer l'instance à son état d'origine. L'instance restera dans cet état jusqu'à ce que le rollback aboutisse.
REPLICATION_ESTABLISHED L'instance est en cours de migration. L'instance a établi une réplication réussie et est prête pour la bascule.
MIGRATED L'instance a bien été migrée.

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 de 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 stratégie LCA appliquée.
aclPolicyRevisionStatuses[]

object (AclPolicyRevisionStatus)

Uniquement en sortie. Liste des états des différentes révisions de cette règle LCA sur l'instance.

Méthodes

addTokenAuthUser

 Ajoute un utilisateur d'authentification par jeton pour une instance sur laquelle l'authentification par jeton est activée.

backup

 Instance de sauvegarde.

create

 Créer une instance dans un projet et un emplacement donnés.

delete

 Supprimer une seule instance.

finishMigration

 Finalise le processus de migration.

get

 Récupère les informations concernant une seule instance.

getCertificateAuthority

 Récupère les détails de l'autorité de certification d'une instance.

list

 Répertorie les instances d'un projet et d'un emplacement donnés.

patch

 Met à jour les paramètres d'une seule instance.

rescheduleMaintenance

 Reprogramme un événement de maintenance à venir.

startMigration

 Lance la migration d'une instance source vers l'instance Memorystore cible.