REST Resource: projects.locations.instances

Ressource : Instance

Une instance Memorystore pour Memcached

Représentation JSON 
{
  "name": string,
  "displayName": string,
  "labels": {
    string: string,
    ...
  },
  "authorizedNetwork": string,
  "zones": [
    string
  ],
  "nodeCount": integer,
  "nodeConfig": {
    object (NodeConfig)
  },
  "memcacheVersion": enum (MemcacheVersion),
  "parameters": {
    object (MemcacheParameters)
  },
  "memcacheNodes": [
    {
      object (Node)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "state": enum (State),
  "memcacheFullVersion": string,
  "instanceMessages": [
    {
      object (InstanceMessage)
    }
  ],
  "discoveryEndpoint": string,
  "updateAvailable": boolean,
  "maintenancePolicy": {
    object (MaintenancePolicy)
  },
  "maintenanceSchedule": {
    object (MaintenanceSchedule)
  },
  "reservedIpRangeId": [
    string
  ],
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean
}
Champs
name

string

Obligatoire. Nom unique de la ressource dans ce champ d'application, y compris le projet et l'emplacement au format suivant : projects/{projectId}/locations/{locationId}/instances/{instanceId}

Remarque : Les instances Memcached sont gérées et traitées au niveau régional. locationId fait ici référence à une région Google Cloud. Toutefois, les utilisateurs peuvent choisir les zones dans lesquelles les nœuds Memcached doivent être provisionnés au sein d'une instance. Pour en savoir plus, consultez le champ zones.
displayName

string

Nom de l'instance fourni par l'utilisateur. Il n'est utilisé qu'à des fins d'affichage. Le nom ne peut pas comporter plus de 80 caractères.
labels

map (key: string, value: string)

Libellés de ressources permettant de représenter les métadonnées fournies par l'utilisateur. Pour en savoir plus, consultez la documentation cloud sur les libellés. https://cloud.google.com/compute/docs/labeling-resources

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

string

Le nom complet du réseau Google Compute Engine auquel l'instance est connectée. S'il n'est pas spécifié, le réseau default sera utilisé.
zones[]

string

Zones dans lesquelles les nœuds Memcached doivent être provisionnés. Les nœuds Memcached seront répartis équitablement entre ces zones. Si aucune valeur n'est fournie, le service crée des nœuds par défaut dans toutes les zones de la région pour l'instance.
nodeCount

integer

Obligatoire. Nombre de nœuds dans l'instance Memcached.
nodeConfig

object (NodeConfig)

Obligatoire. Configuration des nœuds Memcached.
memcacheVersion

enum (MemcacheVersion)

Version majeure du logiciel Memcached. Si non spécifiée, la dernière version compatible sera utilisée. Actuellement, la dernière version majeure acceptée est MEMCACHE_1_5. La version mineure sera identifiée automatiquement par notre système en fonction de la dernière version mineure compatible.
parameters

object (MemcacheParameters)

Paramètres définis par l'utilisateur à appliquer au processus Memcached sur chaque nœud.
memcacheNodes[]

object (Node)

Uniquement en sortie. Liste des nœuds Memcached. Pour en savoir plus, consultez le message Node.
createTime

string (Timestamp format)

Uniquement en sortie. Heure de création de l'instance.

Utilise la norme RFC 3339, où le résultat généré est toujours normalisé avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" 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 l'instance a été mise à jour.

Utilise la norme RFC 3339, où le résultat généré est toujours normalisé avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" 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 de cette instance Memcached.
memcacheFullVersion

string

Uniquement en sortie. Version complète du serveur Memcached exécutée sur cette instance. Le système détermine automatiquement la version complète de Memcached pour une instance en fonction de l'entrée MemcacheVersion. Le format de la version complète sera "memcached-1.5.16".
instanceMessages[]

object (InstanceMessage)

Liste des messages décrivant l'état actuel de l'instance Memcached.
discoveryEndpoint

string

Uniquement en sortie. Point de terminaison de l'API Discovery.
updateAvailable

boolean

Uniquement en sortie. Renvoie la valeur "true" si une mise à jour est en attente d'application.
maintenancePolicy

object (MaintenancePolicy)

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é.
reservedIpRangeId[]

string

Facultatif. Contient l'ID des plages d'adresses IP allouées associées à la connexion d'accès au service privé. Par exemple, "test-default" associé à la plage d'adresses IP 10.0.0.0/29.
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.

NodeConfig

Configuration d'un nœud Memcached.

Représentation JSON 
{
  "cpuCount": integer,
  "memorySizeMb": integer
}
Champs
cpuCount

integer

Obligatoire. Nombre de processeurs par nœud Memcached.
memorySizeMb

integer

Obligatoire. Taille de la mémoire en Mio pour chaque nœud Memcached.

MemcacheVersion

Versions Memcached compatibles avec notre service.

Énumérations
MEMCACHE_VERSION_UNSPECIFIED Le client n'a pas spécifié la version de Memcache.
MEMCACHE_1_5 Version 1.5 de Memcached.
MEMCACHE_1_6_15 Version 1.6.15 de Memcached.

MemcacheParameters

Représentation JSON 
{
  "id": string,
  "params": {
    string: string,
    ...
  }
}
Champs
id

string

Uniquement en sortie. ID unique associé à cet ensemble de paramètres. Les utilisateurs peuvent utiliser cet identifiant pour déterminer si les paramètres associés à l'instance diffèrent de ceux associés aux nœuds. Une différence entre les ID de paramètres peut indiquer aux utilisateurs qu'ils devront peut-être effectuer une action pour appliquer des paramètres aux nœuds.
params

map (key: string, value: string)

Ensemble de paramètres définis par l'utilisateur à utiliser dans le processus Memcached.

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

Nœud

Représentation JSON 
{
  "nodeId": string,
  "zone": string,
  "state": enum (State),
  "host": string,
  "port": integer,
  "parameters": {
    object (MemcacheParameters)
  },
  "updateAvailable": boolean,
  "memcacheVersion": enum (MemcacheVersion),
  "memcacheFullVersion": string
}
Champs
nodeId

string

Uniquement en sortie. Identifiant du nœud Memcached. L'ID du nœud n'inclut pas de projet ou d'emplacement tel que le nom de l'instance Memcached.
zone

string

Uniquement en sortie. Emplacement (zone GCP) du nœud Memcached.
state

enum (State)

Uniquement en sortie. État actuel du nœud Memcached.
host

string

Uniquement en sortie. Nom d'hôte ou adresse IP du nœud Memcached utilisé par les clients pour se connecter au serveur Memcached sur ce nœud.
port

integer

Uniquement en sortie. Numéro de port du serveur Memcached sur ce nœud.
parameters

object (MemcacheParameters)

Paramètres définis par l'utilisateur actuellement appliqués au nœud.
updateAvailable

boolean

Uniquement en sortie. Renvoie la valeur "true" si une mise à jour est en attente d'application.
memcacheVersion

enum (MemcacheVersion)

Uniquement en sortie. Version majeure du serveur Memcached exécutée sur ce nœud (par exemple, MEMCACHE_1_5).
memcacheFullVersion

string

Uniquement en sortie. Version complète du serveur Memcached exécutée sur ce nœud (par exemple, memcached-1.5.16).

État

Différents états d'un nœud Memcached.

Enums
STATE_UNSPECIFIED L'état du nœud n'est pas défini.
CREATING Le nœud est en cours de création.
READY Le nœud est créé et prêt à être utilisé.
DELETING Le nœud est en cours de suppression.
UPDATING Le nœud est en cours de mise à jour.

État

Différents états d'une instance Memcached.

Enums
STATE_UNSPECIFIED État non défini.
CREATING L'instance Memcached est en cours de création.
READY L'instance Memcached est créée et prête à être utilisée.
UPDATING L'instance Memcached met à jour la configuration, comme la règle et la planification de maintenance.
DELETING L'instance Memcached est en cours de suppression.
PERFORMING_MAINTENANCE L'instance Memcached est en cours de maintenance (par exemple, déploiement du plan de données).
MEMCACHE_VERSION_UPGRADING La version du moteur Memcached de l'instance Memcached est en cours de mise à niveau.

InstanceMessage

Représentation JSON 
{
  "code": enum (Code),
  "message": string
}
Champs
code

enum (Code)

Code correspondant à un type de message destiné aux utilisateurs.
message

string

Message sur l'instance Memcached qui sera soumis aux utilisateurs.

Code

Enums
CODE_UNSPECIFIED Code du message non défini.
ZONE_DISTRIBUTION_UNBALANCED Les nœuds Memcached sont répartis de manière inégale.

MaintenancePolicy

Stratégie de maintenance par instance.

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

string (Timestamp format)

Uniquement en sortie. Heure à laquelle la règle a été créée.

Utilise la norme RFC 3339, où le résultat généré est toujours normalisé avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" 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 le règlement a été mis à jour.

Utilise la norme RFC 3339, où le résultat généré est toujours normalisé avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
description

string

Description de l'objectif de ce règlement. Les méthodes Create/Update renvoient INVALID_ARGUMENT si la longueur est supérieure à 512.
weeklyMaintenanceWindow[]

object (WeeklyMaintenanceWindow)

Obligatoire. Période de maintenance appliquée aux ressources couvertes par cette règle. Minimum : 1. Pour la version actuelle, le nombre maximal de weekly_maintenance_windows doit être égal à un.

WeeklyMaintenanceWindow

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

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

enum (DayOfWeek)

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

object (TimeOfDay)

Obligatoire. Heure de début de la période en UTC.
duration

string (Duration format)

Obligatoire. Durée de la période.

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

MaintenanceSchedule

Calendrier de maintenance à venir.

Représentation JSON 
{
  "startTime": string,
  "endTime": string,
  "scheduleDeadlineTime": 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ù le résultat généré est toujours normalisé avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" 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ù le résultat généré est toujours normalisé avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
scheduleDeadlineTime

string (Timestamp format)

Uniquement en sortie. Date limite à ne pas dépasser pour la date de début de la période de maintenance, y compris en cas de reprogrammation.

Utilise la norme RFC 3339, où le résultat généré est toujours normalisé avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

Méthodes

applyParameters

 ApplyParameters redémarre l'ensemble de nœuds spécifiés afin de les mettre à jour avec l'ensemble actuel de paramètres de l'instance Memcached.

applySoftwareUpdate

 Met à jour le logiciel sur les nœuds sélectionnés de l'instance.

create

 Crée une instance dans un emplacement donné.

delete

 Supprimer une seule instance.

get

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

list

 Répertorie les instances d'un emplacement donné.

patch

 Met à jour une instance existante dans un projet et un emplacement donnés.

rescheduleMaintenance

 Exécute la phase d'application du verbe RescheduleMaintenance.

updateParameters

 Met à jour les paramètres Memcached définis pour une instance existante.

upgrade

 Met à niveau l'instance Memcache vers une version plus récente du moteur Memcached spécifiée dans la requête.