Ressource REST : projects.locations.instances

Ressource : Instance

Une instance Google Cloud Redis.

Représentation JSON 

{
  "name": string,
  "displayName": string,
  "labels": {
    string: string,
    ...
  },
  "locationId": string,
  "alternativeLocationId": string,
  "redisVersion": string,
  "reservedIpRange": string,
  "host": string,
  "port": number,
  "currentLocationId": string,
  "createTime": string,
  "state": enum(State),
  "statusMessage": string,
  "redisConfigs": {
    string: string,
    ...
  },
  "tier": enum(Tier),
  "memorySizeGb": number,
  "authorizedNetwork": string,
  "persistenceIamIdentity": string
}
Champs
name

string

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

Remarque : Les instances Redis 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 la zone spécifique (ou l'ensemble des zones pour les instances interzones) dans laquelle une instance doit être provisionnée. Reportez-vous aux champs [locationId] et [alternativeLocationId] pour plus de détails.
displayName

string

Nom arbitraire et facultatif fourni par l'utilisateur pour l'instance.

labels

map (key: string, value: string)

Libellés de ressources permettant de représenter les métadonnées fournies par l'utilisateur.

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

string

Facultatif. La zone dans laquelle l'instance sera provisionnée. Si elle n'est pas spécifiée, le service choisira une zone pour l'instance. En ce qui concerne le niveau STANDARD_HA, des instances seront créées dans deux zones en guise de protection contre les défaillances de zone. Si le champ [alternativeLocationId] est également fourni, il doit être différent de [locationId].

alternativeLocationId

string

Facultatif. S'applique uniquement au niveau STANDARD_HA, qui protège l'instance des défaillances de zone en la provisionnant sur deux zones. Si spécifiée, la zone doit être différente de celle fournie dans [locationId].

redisVersion

string

Facultatif. La version du logiciel Redis. Si non spécifiée, la dernière version compatible sera utilisée. La mise à jour de la version effectuera une mise à niveau vers la nouvelle version. À l'heure actuelle, les valeurs compatibles sont REDIS_3_2 pour Redis 3.2.

reservedIpRange

string

Facultatif. La plage d'adresses internes CIDR réservées pour cette instance. Si elle n'est pas spécifiée, le service choisira un bloc non utilisé se terminant par /29. Exemple : 10.0.0.0/29 ou 192.168.0.0/29. Les plages doivent être uniques et ne pas chevaucher les sous-réseaux existants d'un réseau autorisé.

host

string

Uniquement en sortie. Nom d'hôte ou adresse IP du point de terminaison Redis exposé, que les clients utilisent pour se connecter au service.

port

number

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

currentLocationId

string

Uniquement en sortie. La zone actuelle dans laquelle se trouve le point de terminaison Redis. Pour les instances de niveau de base, ce champ sera toujours identique au champ [locationId] fourni par l'utilisateur au moment de la création. Pour les instances de niveau standard, il peut s'agir de [locationId] ou de [alternativeLocationId]. Cela peut changer après un événement de basculement.

createTime

string (Timestamp format)

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

Un 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. L'état actuel de cette instance.

statusMessage

string

Uniquement en sortie. Informations supplémentaires sur l'état actuel de cette instance, le cas échéant.

redisConfigs

map (key: string, value: string)

Facultatif. Paramètres de configuration de Redis, conformément à http://redis.io/topics/config. À l'heure actuelle, les paramètres suivants sont les seuls à être compatibles :

  • maxmemory-policy
  • notify-keyspace-events

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

enum(Tier)

Obligatoire. Le niveau de service de l'instance.

memorySizeGb

number

Obligatoire. La taille de la mémoire Redis en Gio.

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

persistenceIamIdentity

string

Uniquement en sortie. L'identité IAM utilisée par les opérations d'importation/d'exportation pour transférer des données vers/depuis GCS. Le format est "serviceAccount:". La valeur peut changer au fil du temps pour une instance donnée, et doit donc être vérifiée avant chaque opération d'importation/d'exportation.

État

Représente les différents états d'une instance Redis.

Enums
STATE_UNSPECIFIED Non défini.
CREATING L'instance Redis est en cours de création.
READY L'instance Redis a été créée et est entièrement utilisable.
UPDATING La configuration de l'instance Redis est en cours de mise à jour. Certains types de mises à jour peuvent rendre l'instance inutilisable pendant l'opération.
DELETING L’instance Redis est en cours de suppression.
REPAIRING L'instance Redis est en cours de réparation et peut être inutilisable. Des détails figurent dans le champ statusMessage.
MAINTENANCE Une opération de maintenance est en cours sur cette instance Redis.
IMPORTING L'instance Redis est en cours de réparation et peut être inutilisable.

Niveau

Niveaux de service disponibles :

Enums
TIER_UNSPECIFIED Non défini.
BASIC Niveau de base : instance autonome.
STANDARD_HA Niveau STANDARD_HA : instances primaires/dupliquées hautement disponibles.

Méthodes

create

 Crée une instance Redis en fonction du niveau spécifié et de la taille de la mémoire.

delete

 Supprime une instance Redis spécifique.

get

 Obtient les détails d'une instance Redis spécifique.

list

 Répertorie toutes les instances Redis associées à un projet à l'emplacement spécifié (région) ou à tous les emplacements.

patch

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