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)
    }
  ],
  "endpoints": [
    {
      object (InstanceEndpoint)
    }
  ],
  "mode": enum (Mode),
  "replicaCount": integer,
  "deletionProtectionEnabled": 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.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la dernière mise à jour de l'instance.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
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" }.
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 à l'instance.
authorizationMode

enum (AuthorizationMode)

Facultatif. Immuable. 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[]

object (DiscoveryEndpoint)

Uniquement en sortie. Points de terminaison par lesquels les clients peuvent se connecter à l'instance. Pour le moment, un seul point de terminaison de découverte est accepté.
nodeType

enum (NodeType)

Facultatif. Immuable. 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. Immuable. 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 de nœuds.
pscAutoConnections[]

object (PscAutoConnection)

Obligatoire. Immuable. Entrées utilisateur et informations sur les ressources des connexions PSC créées automatiquement.
endpoints[]

object (InstanceEndpoint)

Facultatif. Points de terminaison de l'instance.
mode

enum (Mode)

Facultatif. Configuration du mode pour l'instance.
replicaCount

integer

Facultatif. Nombre de nœuds d'instances répliquées par segment. Si cette valeur est omise, la valeur par défaut est 0.
deletionProtectionEnabled

boolean

Facultatif. Si cette valeur est définie sur "true", la suppression de l'instance échoue.

É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…

StateInfo

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

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)

Uniquement en sortie. Décrit la mise à jour en cours lorsque l'état de l'instance est UPDATING.

UpdateInfo

Représente des informations sur l'instance avec l'état UPDATING.

Représentation JSON 
{
  "targetShardCount": integer,
  "targetReplicaCount": integer
}
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.

AuthorizationMode

Modes d'autorisation possibles de l'instance.

Enums
AUTHORIZATION_MODE_UNSPECIFIED Non défini.
AUTH_DISABLED Autorisation désactivée.
IAM_AUTH Autorisation de base IAM.

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

NodeType

Types de nœuds possibles de l'instance. Pour en savoir plus, consultez la page https://cloud.google.com/memorystore/docs/valkey/instance-node-specification.

Enums
NODE_TYPE_UNSPECIFIED Non défini.
SHARED_CORE_NANO Nano à cœur partagé.
HIGHMEM_MEDIUM Moyenne de mémoire élevée.
HIGHMEM_XLARGE Mémoire élevée, très grande.
STANDARD_SMALL Taille standard (petite)

PersistenceConfig

Représente la configuration de la persistance pour 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 est ignoré si le mode n'est pas RDB.
aofConfig

object (AOFConfig)

Facultatif. Configuration AOF. Ce champ est 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 le RDB est activée.
AOF La persistance basée sur AOF est activée.

RDBConfig

Configuration pour la persistance basée sur RDB.

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

enum (SnapshotPeriod)

Facultatif. Intervalle entre les instantanés RDB.
rdbSnapshotStartTime

string (Timestamp format)

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

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

SnapshotPeriod

Périodes d'instantanés possibles.

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

AOFConfig

Configuration pour la persistance basée sur 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 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.
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 en Go du nœud.

ZoneDistributionConfig

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

Représentation JSON 
{
  "zone": 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.
mode

enum (ZoneDistributionMode)

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

ZoneDistributionMode

Modes de distribution des zones possibles.

Enums
ZONE_DISTRIBUTION_MODE_UNSPECIFIED Non défini. Valeur 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),

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

Uniquement en sortie. ID de connexion PSC de la règle de transfert associé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é client. Format: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
projectId

string

Obligatoire. ProjectId du client où les connexions PSC sont établies. Il doit s'agir du même projectId 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_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: une connexion existe-t-elle et est-elle ACTIVE ou n'existe-t-elle plus ? Notez que cette valeur est mise à jour régulièrement. Pour connaître l'état le plus récent, veuillez utiliser les API Private Service Connect.
connectionType

enum (ConnectionType)

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

integer

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

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

InstanceEndpoint

InstanceEndpoint se compose de connexions PSC créées en 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. 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 sur chaque connexion PSC.

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 à 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). 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 l'utilisateur.

PscConnection

L'utilisateur a créé une configuration de connexion Psc.

Représentation JSON 
{
  "pscConnectionId": string,
  "ipAddress": 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.
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é client. Format: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
projectId

string

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

string

Obligatoire. Réseau client où se trouve 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: une connexion existe-t-elle et est-elle ACTIVE ou n'existe-t-elle plus ? Notez que cette valeur est mise à jour régulièrement. Pour connaître l'état le plus récent, veuillez utiliser les API Private Service Connect.
connectionType

enum (ConnectionType)

Uniquement en sortie. Type de connexion PSC.

Mode

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

Enums
MODE_UNSPECIFIED Le mode n'est pas spécifié.
CLUSTER L'instance est en mode cluster.
CLUSTER_DISABLED Le mode cluster est désactivé pour l'instance.

Méthodes

create

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

delete

 Supprime une seule instance.

get

 Récupérer les détails d'une seule instance.

getCertificateAuthority

 Récupère des informations sur 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.