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,
  "updateAvailable": boolean,
  "maintenancePolicy": {
    object (MaintenancePolicy)
  },
  "maintenanceSchedule": {
    object (MaintenanceSchedule)
  },
  "reservedIpRangeId": [
    string
  ],
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean
}
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 nichts angegeben ist, 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 Memcache-Knoten.
memcacheVersion

enum (MemcacheVersion)

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

object (MemcacheParameters)

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

object (Node)

Nur Ausgabe. Liste der Memcache-Knoten. Weitere Informationen finden Sie in der Node-Nachricht.
createTime

string (Timestamp format)

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

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

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

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
state

enum (State)

Nur Ausgabe. Der Status dieser Memcached-Instanz.
memcacheFullVersion

string

Nur Ausgabe. Die vollständige Version des Memcache-Servers, der auf dieser Instanz ausgeführt wird. Das System bestimmt automatisch die vollständige memcached-Version für eine Instanz basierend auf der Eingabe MemcacheVersion. Das vollständige Versionsformat ist „memcached-1.5.16“.
instanceMessages[]

object (InstanceMessage)

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

string

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

boolean

Nur Ausgabe. Gibt „true“ zurück, wenn ein Update zur Anwendung bereitsteht.
maintenancePolicy

object (MaintenancePolicy)

Die Wartungsrichtlinie für die Instanz. Wenn nicht angegeben, wird das Wartungsereignis gemäß dem internen Memorystore-Rollout-Zeitplan ausgeführt.
maintenanceSchedule

object (MaintenanceSchedule)

Nur Ausgabe. Veröffentlichter Wartungszeitplan
reservedIpRangeId[]

string

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

boolean

Optional. Nur Ausgabe. Reserviert für zukünftige Verwendungen.
satisfiesPzi

boolean

Optional. Nur Ausgabe. Reserviert für zukünftige Verwendungen.

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 Die Memcache-Version wurde vom Kunden nicht angegeben.
MEMCACHE_1_5 Memcached 1.5-Version.
MEMCACHE_1_6_15 Memcached 1.6.15-Version.

MemcacheParameters

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

string

Nur Ausgabe. Die eindeutige ID, die dieser Gruppe von Parametern zugeordnet ist. Mithilfe dieser ID können Nutzer feststellen, ob sich die Parameter der Instanz von den Parametern der Knoten unterscheiden. Eine Abweichung zwischen Parameter-IDs kann Nutzer darauf hinweisen, dass sie Maßnahmen ergreifen müssen, um Parameter auf Knoten anzuwenden.
params

map (key: string, value: string)

Benutzerdefinierter Satz von Parametern, die im Memcached-Prozess verwendet werden sollen.

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)
  },
  "updateAvailable": boolean,
  "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.
updateAvailable

boolean

Nur Ausgabe. Gibt „true“ zurück, wenn ein Update zur Anwendung bereitsteht.
memcacheVersion

enum (MemcacheVersion)

Nur Ausgabe. Hauptversion des Memcached-Servers, der auf diesem Knoten ausgeführt wird, z.B. MEMCACHE_1_5
memcacheFullVersion

string

Nur Ausgabe. Die vollständige Version des Memcached-Servers, der auf diesem Knoten ausgeführt wird, z. B. „memcached-1.5.16“.

Bundesland

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.

State

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 Konfiguration der Memcached-Instanz wird aktualisiert, z. B. die Wartungsrichtlinie und der Zeitplan.
DELETING Die Memcache-Instanz wird gelöscht.
PERFORMING_MAINTENANCE Die Memcached-Instanz wird gewartet, z. B. die Einführung der Datenebene.
MEMCACHE_VERSION_UPGRADING Die Memcached-Instanz wird auf eine neue Version der Memcached-Engine aktualisiert.

InstanceMessage

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

enum (Code)

Ein Code, der einer Art von nutzerorientierter Meldung 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.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

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

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
description

string

Beschreibung, wozu diese Richtlinie dient. Die Methoden zum Erstellen/Aktualisieren geben INVALID_ARGUMENT zurück, wenn die Länge größer als 512 ist.
weeklyMaintenanceWindow[]

object (WeeklyMaintenanceWindow)

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

WeeklyMaintenanceWindow

Für wöchentliche Vorgänge angegebenes Zeitfenster.

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

enum (DayOfWeek)

Erforderlich. Ermöglicht die Definition eines Zeitplans, der am angegebenen 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.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

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

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
scheduleDeadlineTime

string (Timestamp format)

Nur Ausgabe. Die Frist, die für den Beginn des Wartungszeitplans nicht überschritten werden darf, einschließlich der Verschiebung.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

Methoden

applyParameters

 ApplyParameters startet die angegebenen Knoten neu, um sie auf den aktuellen Parametersatz für die Memcached-Instanz zu aktualisieren.

applySoftwareUpdate

 Aktualisiert die Software auf den ausgewählten Knoten der Instanz.

create

 Erstellt eine neue Instanz an einem angegebenen Ort.

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 angegebenen Projekt und an einem angegebenen Standort.

rescheduleMaintenance

 Führt die Anwendungsphase des Verbs „RescheduleMaintenance“ aus.

updateParameters

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

upgrade

 Führt ein Upgrade der Memcache-Instanz auf eine neuere Memcached-Engine-Version durch, die in der Anfrage angegeben ist.