Ressource REST : projects.locations.instances

Ressource : Instance

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
}
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/{project_id}/locations/{locationId}/instances/{instanceId}

Remarque : Les instances Memcached sont gérées et traitées au niveau régional. L'emplacement locationId fait ici référence à une région GCP. 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, reportez-vous au champ [zones].

displayName

string

Facultatif. 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)

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

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

Facultatif. 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)

Facultatif. 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)

Facultatif : 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, reportez-vous au message [Node].

createTime

string (Timestamp format)

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

Horodatage au format RFC3339 UTC "Zulu", précis à la nanoseconde près. Exemple : "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle l'instance a été mise à jour.

Horodatage au format RFC3339 UTC "Zulu", précis à la nanoseconde près. Exemple : "2014-10-02T15:01:23.045123456Z".

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 de messages décrivant les états actuels de l'instance Memcached.

discoveryEndpoint

string

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

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.

Enums
MEMCACHE_VERSION_UNSPECIFIED
MEMCACHE_1_5 Version 1.5 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 et si une action doit être entreprise 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)
  }
}
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.

É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.
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).

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.

Méthodes

applyParameters

La méthode ApplyParameters met à jour l'ensemble actuel de paramètres vers l'ensemble de nœuds spécifiés dans l'instance Memcached.

create

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

delete

Supprime une seule instance.

get

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

getIamPolicy

Récupère la stratégie de contrôle d'accès d'une ressource.

list

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

patch

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

setIamPolicy

Définit la stratégie de contrôle d'accès de la ressource spécifiée.

testIamPermissions

Renvoie les autorisations qu'un appelant a sur la ressource spécifiée.

updateParameters

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