REST Resource: projects.locations.instances

Ressource: Instanz

Eine Memorystore for Memcached-Instanz

JSON-Darstellung 
{
  "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,
  "maintenancePolicy": {
    object (MaintenancePolicy)
  },
  "maintenanceSchedule": {
    object (MaintenanceSchedule)
  },
  "reservedIpRangeId": [
    string
  ]
}
Felder
name

string

Erforderlich. Eindeutiger Name der Ressource in diesem Bereich, einschließlich Projekt und Standort, die folgendes Format haben: projects/{projectId}/locations/{locationId}/instances/{instanceId}

Hinweis: Memcached-Instanzen werden auf regionaler Ebene verwaltet und adressiert. locationId bezieht sich hier also auf eine Google Cloud-Region. Nutzer können jedoch auswählen, in welchen Zonen Memcached-Knoten innerhalb einer Instanz bereitgestellt werden sollen. Weitere Informationen finden Sie im Feld zones.
displayName

string

Vom Nutzer angegebener Name für die Instanz, der nur zu Anzeigezwecken verwendet wird. Darf nicht länger als 80 Zeichen sein.
labels

map (key: string, value: string)

Ressourcenetiketten zur Darstellung der vom Nutzer bereitgestellten Metadaten. Weitere Informationen finden Sie in der Cloud-Dokumentation zu Labels. https://cloud.google.com/compute/docs/labeling-resources

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
authorizedNetwork

string

Der vollständige Name des Google Compute Engine-Netzwerks, mit dem die Instanz verbunden ist. Wenn nicht angegeben, wird das Netzwerk defaultverwendet.
zones[]

string

Zonen, in denen Memcached-Knoten bereitgestellt werden sollen. Memcached-Knoten werden gleichmäßig auf diese Zonen verteilt. Wenn nicht angegeben, erstellt der Dienst standardmäßig Knoten in allen Zonen der Region für die Instanz.
nodeCount

integer

Erforderlich. Anzahl der Knoten in der Memcached-Instanz.
nodeConfig

object (NodeConfig)

Erforderlich. Konfiguration für Memcached-Knoten.
memcacheVersion

enum (MemcacheVersion)

Die Hauptversion der Memcached-Software. Wenn nicht angegeben, wird die neueste unterstützte Version verwendet. Die neueste unterstützte Hauptversion ist derzeit MEMCACHE_1_5. Die Nebenversion wird von unserem System automatisch anhand der neuesten unterstützten Nebenversion ermittelt.
parameters

object (MemcacheParameters)

Benutzerdefinierte Parameter, die auf den Memcached-Prozess auf jedem Knoten angewendet werden sollen.
memcacheNodes[]

object (Node)

Nur Ausgabe. Liste der Memcached-Knoten. Weitere Informationen finden Sie in der Node-Meldung.
createTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem die Instanz erstellt wurde.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem die Instanz aktualisiert wurde.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Nur Ausgabe. Der Status dieser Memcached-Instanz.
memcacheFullVersion

string

Nur Ausgabe. Die Vollversion des auf dieser Instanz ausgeführten Memcached-Servers. Das System bestimmt automatisch die vollständige Memcached-Version für eine Instanz anhand der MemcacheVersion-Eingabe. Das Format der Vollversion hat das Format „Memcached-1.5.16“.
instanceMessages[]

object (InstanceMessage)

Liste der Nachrichten, die den aktuellen Status der Memcached-Instanz beschreiben.
discoveryEndpoint

string

Nur Ausgabe. Endpunkt für die Discovery API.
maintenancePolicy

object (MaintenancePolicy)

Die Wartungsrichtlinie für die Instanz. Wenn nicht angegeben, wird das Wartungsereignis basierend auf dem internen Roll-out-Zeitplan von Memorystore ausgeführt.
maintenanceSchedule

object (MaintenanceSchedule)

Nur Ausgabe. Veröffentlichter Wartungsplan.
reservedIpRangeId[]

string

Optional. Enthält die ID der zugewiesenen IP-Adressbereiche, die mit der Verbindung für den privaten Dienstzugriff verknüpft sind, z. B. „test-default“ für den IP-Bereich 10.0.0.0/29.

NodeConfig

Konfiguration für einen Memcache-Knoten.

JSON-Darstellung 
{
  "cpuCount": integer,
  "memorySizeMb": integer
}
Felder
cpuCount

integer

Erforderlich. Anzahl der CPU-Ressourcen pro Memcache-Knoten.
memorySizeMb

integer

Erforderlich. Arbeitsspeichergröße in MiB für jeden Memcache-Knoten.

MemcacheVersion

Memcache-Versionen, die von unserem Dienst unterstützt werden.

Enums
MEMCACHE_VERSION_UNSPECIFIED Memcache-Version wurde vom Kunden nicht angegeben
MEMCACHE_1_5 Memcached 1.5-Version.
MEMCACHE_1_6_15 Memcached 1.6.15.

MemcacheParameters

JSON-Darstellung 
{
  "id": string,
  "params": {
    string: string,
    ...
  }
}
Felder
id

string

Nur Ausgabe. Die eindeutige ID, die dieser Gruppe von Parametern zugeordnet ist. Nutzer können anhand dieser ID feststellen, ob sich die mit der Instanz verknüpften Parameter von den Parametern unterscheiden, die mit den Knoten verknüpft sind. Eine Abweichung zwischen den Parameter-IDs kann Nutzer darüber informieren, dass sie möglicherweise Maßnahmen ergreifen müssen, um Parameter auf Knoten anzuwenden.
params

map (key: string, value: string)

Benutzerdefinierte Gruppe von Parametern zur Verwendung im Memcache-Prozess.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Node

JSON-Darstellung 
{
  "nodeId": string,
  "zone": string,
  "state": enum (State),
  "host": string,
  "port": integer,
  "parameters": {
    object (MemcacheParameters)
  },
  "memcacheVersion": enum (MemcacheVersion),
  "memcacheFullVersion": string
}
Felder
nodeId

string

Nur Ausgabe. Kennzeichnung des Memcache-Knotens. Die Knoten-ID enthält weder das Projekt noch den Standort wie den Memcache-Instanznamen.
zone

string

Nur Ausgabe. Speicherort (GCP-Zone) für den Memcache-Knoten.
state

enum (State)

Nur Ausgabe. Aktueller Status des Memcache-Knotens:
host

string

Nur Ausgabe. Hostname oder IP-Adresse des Memcache-Knotens, der von den Clients verwendet wird, um eine Verbindung zum Memcache-Server auf diesem Knoten herzustellen.
port

integer

Nur Ausgabe. Die Portnummer des Memcache-Servers auf diesem Knoten.
parameters

object (MemcacheParameters)

Benutzerdefinierte Parameter, die derzeit auf den Knoten angewendet werden.
memcacheVersion

enum (MemcacheVersion)

Nur Ausgabe. Auf diesem Knoten ausgeführte Hauptversion des Memcached-Servers, z.B. MEMCACHE_1_5
memcacheFullVersion

string

Nur Ausgabe. Die Vollversion des Memcached-Servers, der auf diesem Knoten ausgeführt wird. Beispiel: Memcache-1.5.16

Status

Verschiedene Status eines Memcached-Knotens.

Enums
STATE_UNSPECIFIED Der Knotenstatus ist nicht festgelegt.
CREATING Der Knoten wird erstellt.
READY Der Knoten wurde erstellt und ist einsatzbereit.
DELETING Der Knoten wird gelöscht.
UPDATING Der Knoten wird aktualisiert.

Status

Verschiedene Status einer Memcached-Instanz.

Enums
STATE_UNSPECIFIED Kein Status festgelegt.
CREATING Die Memcache-Instanz wird erstellt.
READY Die Memcache-Instanz wurde erstellt und ist einsatzbereit.
UPDATING Die Memcached-Instanz aktualisiert die Konfiguration, z. B. die Wartungsrichtlinie und den Wartungsplan.
DELETING Die Memcache-Instanz wird gelöscht.
PERFORMING_MAINTENANCE Die Memcached-Instanz wird gewartet, z. B. die Einführung der Datenebene.
MEMCACHE_VERSION_UPGRADING Für die Memcached-Instanz wird ein Upgrade der Memcached-Engine-Version durchgeführt.

InstanceMessage

JSON-Darstellung 
{
  "code": enum (Code),
  "message": string
}
Felder
code

enum (Code)

Ein Code, der einer Art von an den Nutzer gerichteter Mitteilung entspricht.
message

string

Die Nachricht auf Memcache-Instanz, die den Nutzern zur Verfügung gestellt wird.

Code

Enums
CODE_UNSPECIFIED Der Nachrichtencode ist nicht festgelegt.
ZONE_DISTRIBUTION_UNBALANCED Die Memcache-Knoten werden ungleichmäßig verteilt.

MaintenancePolicy

Wartungsrichtlinie pro Instanz.

JSON-Darstellung 
{
  "createTime": string,
  "updateTime": string,
  "description": string,
  "weeklyMaintenanceWindow": [
    {
      object (WeeklyMaintenanceWindow)
    }
  ]
}
Felder
createTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem die Richtlinie erstellt wurde.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem die Richtlinie aktualisiert wurde.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
description

string

Beschreibung des Zwecks dieser Richtlinie. Bei Erstellungs-/Aktualisierungsmethoden wird INVALID_ARGUMENT zurückgegeben, wenn die Länge größer als 512 ist.
weeklyMaintenanceWindow[]

object (WeeklyMaintenanceWindow)

Erforderlich. Wartungsfenster, das auf Ressourcen angewendet wird, die von dieser Richtlinie abgedeckt werden. Mindestens 1 Für die aktuelle Version wird erwartet, dass die maximale Anzahl von weeks_Maintenance_windows eins ist.

WeeklyMaintenanceWindow

Zeitfenster für wöchentliche Vorgänge angegeben.

JSON-Darstellung 
{
  "day": enum (DayOfWeek),
  "startTime": {
    object (TimeOfDay)
  },
  "duration": string
}
Felder
day

enum (DayOfWeek)

Erforderlich. Definieren Sie einen Zeitplan, der an einem bestimmten Wochentag ausgeführt wird.
startTime

object (TimeOfDay)

Erforderlich. Beginn des Zeitfensters in UTC.
duration

string (Duration format)

Erforderlich. Dauer des Zeitfensters.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".

MaintenanceSchedule

Anstehender Wartungsplan.

JSON-Darstellung 
{
  "startTime": string,
  "endTime": string,
  "scheduleDeadlineTime": string
}
Felder
startTime

string (Timestamp format)

Nur Ausgabe. Die Startzeit einer anstehenden geplanten Wartung für diese Instanz.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Nur Ausgabe. Die Endzeit einer anstehenden geplanten Wartung für diese Instanz.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
scheduleDeadlineTime

string (Timestamp format)

Nur Ausgabe. Die Frist, die der Beginn des Wartungsplans nicht überschreiten darf, einschließlich einer Neuplanung.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

Methoden

applyParameters

 ApplyParameters startet die Gruppe der angegebenen Knoten neu, um sie auf den aktuellen Satz von Parametern für die Memcached-Instanz zu aktualisieren.

create

 Erstellt eine neue Instanz an einem bestimmten Standort.

delete

 Löscht eine einzelne Instanz.

get

 Ruft Details zu einer einzelnen Instanz ab.

list

 Listet Instanzen an einem bestimmten Standort auf.

patch

 Aktualisiert eine vorhandene Instanz in einem bestimmten Projekt und an einem bestimmten Standort.

rescheduleMaintenance

 Plant ein bevorstehendes Wartungsereignis neu.

updateParameters

 Aktualisiert die definierten Memcached-Parameter für eine vorhandene Instanz.

upgrade

 Die Memcache-Instanz wird auf eine neuere Version der Memcached-Engine aktualisiert, die in der Anfrage angegeben ist.