REST Resource: projects.locations.instances

Ressource: Instanz

Eine Memorystore-Instanz.

JSON-Darstellung 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "state": enum (State),
  "stateInfo": {
    object (StateInfo)
  },
  "uid": string,
  "authorizationMode": enum (AuthorizationMode),
  "transitEncryptionMode": enum (TransitEncryptionMode),
  "shardCount": integer,
  "discoveryEndpoints": [
    {
      object (DiscoveryEndpoint)
    }
  ],
  "nodeType": enum (NodeType),
  "persistenceConfig": {
    object (PersistenceConfig)
  },
  "engineVersion": string,
  "engineConfigs": {
    string: string,
    ...
  },
  "nodeConfig": {
    object (NodeConfig)
  },
  "zoneDistributionConfig": {
    object (ZoneDistributionConfig)
  },
  "pscAutoConnections": [
    {
      object (PscAutoConnection)
    }
  ],
  "replicaCount": integer,
  "deletionProtectionEnabled": boolean
}
Felder
name

string

Kennung. Eindeutiger Name der Instanz. Format: projects/{project}/locations/{location}/instances/{instance}
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der Erstellung der 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".
updateTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der letzten Aktualisierung der 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".
labels

map (key: string, value: string)

Optional. Labels zur Darstellung der vom Nutzer bereitgestellten Metadaten.

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

enum (State)

Nur Ausgabe. Aktueller Status der Instanz.
stateInfo

object (StateInfo)

Nur Ausgabe. Zusätzliche Informationen zum Status der Instanz.
uid

string

Nur Ausgabe. Vom System zugewiesene eindeutige Kennung für die Instanz.
authorizationMode

enum (AuthorizationMode)

Optional. Nicht veränderbar. Autorisierungsmodus der Instanz.
transitEncryptionMode

enum (TransitEncryptionMode)

Optional. Nicht veränderbar. Verschlüsselungsmodus der Instanz während der Übertragung.
shardCount

integer

Erforderlich. Anzahl der Shards für die Instanz.
discoveryEndpoints[]

object (DiscoveryEndpoint)

Nur Ausgabe. Endpunkte, über die Clients eine Verbindung zur Instanz herstellen können. Derzeit wird nur ein Discovery-Endpunkt unterstützt.
nodeType

enum (NodeType)

Optional. Nicht veränderbar. Maschinentyp für einzelne Knoten der Instanz.
persistenceConfig

object (PersistenceConfig)

Optional. Speicherkonfiguration der Instanz.
engineVersion

string

Optional. Nicht veränderbar. Engine-Version der Instanz.
engineConfigs

map (key: string, value: string)

Optional. Vom Nutzer bereitgestellte Engine-Konfigurationen für die Instanz.

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

object (NodeConfig)

Nur Ausgabe. Konfiguration der einzelnen Knoten der Instanz.
zoneDistributionConfig

object (ZoneDistributionConfig)

Optional. Nicht veränderbar. Konfiguration der Zonenverteilung der Instanz für die Knotenzuweisung.
pscAutoConnections[]

object (PscAutoConnection)

Erforderlich. Nicht veränderbar. Nutzereingaben und Ressourcendetails der automatisch erstellten PSC-Verbindungen.
replicaCount

integer

Optional. Anzahl der Replikatknoten pro Shard. Wenn keine Angabe gemacht wird, ist der Standardwert „0 Replikate“.
deletionProtectionEnabled

boolean

Optional. Wenn die Richtlinie auf „true“ gesetzt ist, schlägt das Löschen der Instanz fehl.

Bundesland

Mögliche Status der Instanz.

Enums
STATE_UNSPECIFIED Nicht definiert.
CREATING Instanz wird erstellt...
ACTIVE Die Instanz wurde erstellt und kann verwendet werden.
UPDATING Instanz wird aktualisiert.
DELETING Instanz wird gelöscht...

StateInfo

Zusätzliche Informationen zum Status der Instanz.

JSON-Darstellung 
{

  // Union field info can be only one of the following:
  "updateInfo": {
    object (UpdateInfo)
  }
  // End of list of possible types for union field info.
}
Felder

Union-Feld info.

Für info ist nur einer der folgenden Werte zulässig:
updateInfo

object (UpdateInfo)

Nur Ausgabe. Beschreibt das laufende Update, wenn der Instanzstatus UPDATING lautet.

UpdateInfo

Stellt Informationen zu einer Instanz mit dem Status „AKTUALISIERT“ dar.

JSON-Darstellung 
{
  "targetShardCount": integer,
  "targetReplicaCount": integer
}
Felder
targetShardCount

integer

Nur Ausgabe. Die angestrebte Anzahl von Shards für die Instanz.
targetReplicaCount

integer

Nur Ausgabe. Zielanzahl der Replikatknoten pro Shard für die Instanz.

AuthorizationMode

Mögliche Autorisierungsmodi der Instanz.

Enums
AUTHORIZATION_MODE_UNSPECIFIED Nicht definiert.
AUTH_DISABLED Autorisierung deaktiviert.
IAM_AUTH Grundlegende IAM-Autorisierung.

TransitEncryptionMode

Mögliche Verschlüsselungsmodi der Instanz während der Übertragung.

Enums
TRANSIT_ENCRYPTION_MODE_UNSPECIFIED Nicht definiert.
TRANSIT_ENCRYPTION_DISABLED Die Verschlüsselung während der Übertragung ist deaktiviert.
SERVER_AUTHENTICATION Die serverseitige Verschlüsselung wird für die Verschlüsselung während der Übertragung verwendet.

DiscoveryEndpoint

Stellt einen Endpunkt für Clients dar, über den eine Verbindung zur Instanz hergestellt werden kann.

JSON-Darstellung 
{
  "address": string,
  "port": integer,
  "network": string
}
Felder
address

string

Nur Ausgabe. IP-Adresse des bereitgestellten Endpunkts, zu dem Clients eine Verbindung herstellen.
port

integer

Nur Ausgabe. Die Portnummer des bereitgestellten Endpunkts.
network

string

Nur Ausgabe. Das Netzwerk, in dem die IP-Adresse des Discovery-Endpunkts reserviert wird, im Format projects/{networkProject}/global/networks/{network_id}.

NodeType

Mögliche Knotentypen der Instanz. Weitere Informationen finden Sie unter https://cloud.google.com/memorystore/docs/valkey/instance-node-specification.

Enums
NODE_TYPE_UNSPECIFIED Nicht definiert.
SHARED_CORE_NANO Gemeinsam genutzter Kern, nano.
HIGHMEM_MEDIUM Großer Arbeitsspeicher, mittel.
HIGHMEM_XLARGE Großer Arbeitsspeicher, extra groß
STANDARD_SMALL Standard klein

PersistenceConfig

Stellt die Speicherkonfiguration für eine Instanz dar.

JSON-Darstellung 
{
  "mode": enum (PersistenceMode),
  "rdbConfig": {
    object (RDBConfig)
  },
  "aofConfig": {
    object (AOFConfig)
  }
}
Felder
mode

enum (PersistenceMode)

Optional. Aktueller Persistenzmodus.
rdbConfig

object (RDBConfig)

Optional. RDB-Konfiguration. Dieses Feld wird ignoriert, wenn der Modus nicht RDB ist.
aofConfig

object (AOFConfig)

Optional. AOF-Konfiguration. Dieses Feld wird ignoriert, wenn der Modus nicht AOF ist.

PersistenceMode

Mögliche Persistenzmodi

Enums
PERSISTENCE_MODE_UNSPECIFIED Nicht definiert.
DISABLED Die Persistenz ist deaktiviert und Snapshot-Daten werden gelöscht.
RDB Die RDB-basierte Persistenz ist aktiviert.
AOF AOF-basierte Persistenz ist aktiviert.

RDBConfig

Konfiguration für die RDB-basierte Persistenz.

JSON-Darstellung 
{
  "rdbSnapshotPeriod": enum (SnapshotPeriod),
  "rdbSnapshotStartTime": string
}
Felder
rdbSnapshotPeriod

enum (SnapshotPeriod)

Optional. Zeitraum zwischen RDB-Snapshots.
rdbSnapshotStartTime

string (Timestamp format)

Optional. Zeitpunkt, zu dem der erste Snapshot versucht wurde bzw. wird, und auf den zukünftige Snapshots ausgerichtet werden. Wenn nicht angegeben, wird die aktuelle Uhrzeit verwendet.

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

SnapshotPeriod

Mögliche Snapshot-Zeiträume.

Enums
SNAPSHOT_PERIOD_UNSPECIFIED Nicht definiert.
ONE_HOUR einer Stunde.
SIX_HOURS sechs Stunden.
TWELVE_HOURS zwölf Stunden.
TWENTY_FOUR_HOURS 24 Stunden.

AOFConfig

Konfiguration für AOF-basierte Persistenz.

JSON-Darstellung 
{
  "appendFsync": enum (AppendFsync)
}
Felder
appendFsync

enum (AppendFsync)

Optional. fsync-Modus

AppendFsync

Mögliche fsync-Modi.

Enums
APPEND_FSYNC_UNSPECIFIED Nicht definiert. Standard: EVERY_SEC
NEVER Nie fsync. Normalerweise werden bei dieser Konfiguration alle 30 Sekunden Daten gelöscht. Die genaue Abstimmung hängt jedoch vom Kernel ab.
EVERY_SEC Fsync-Gerät jede Sekunde an. Bei einem Notfallereignis können Sie Daten von bis zu einer Sekunde verlieren.
ALWAYS Fsync wird jedes Mal ausgeführt, wenn der AOF neue Schreibbefehle hinzugefügt werden. Der beste Schutz vor Datenverlusten, der aber zu Leistungseinbußen führt.

NodeConfig

Stellt die Konfiguration für Knoten der Instanz dar.

JSON-Darstellung 
{
  "sizeGb": number
}
Felder
sizeGb

number

Nur Ausgabe. Arbeitsspeichergröße des Knotens in GB.

ZoneDistributionConfig

Konfiguration der Zonenverteilung für die Zuweisung von Instanzressourcen.

JSON-Darstellung 
{
  "zone": string,
  "mode": enum (ZoneDistributionMode)
}
Felder
zone

string

Optional. Definiert die Zone, in der alle Ressourcen im Modus SINGLE_ZONE zugewiesen werden. Wird für den MULTI_ZONE-Modus ignoriert.
mode

enum (ZoneDistributionMode)

Optional. Verteilungsmodus der aktuellen Zone. Die Standardeinstellung ist MULTI_ZONE.

ZoneDistributionMode

Mögliche Zonenverteilungsmodi

Enums
ZONE_DISTRIBUTION_MODE_UNSPECIFIED Nicht festgelegt. Standardeinstellung: MULTI_ZONE
MULTI_ZONE Ressourcen auf 3 nach dem Zufallsprinzip ausgewählte Zonen innerhalb der Region verteilen.
SINGLE_ZONE Stellen Sie Ressourcen in einer einzelnen Zone bereit. Das Zonenfeld muss angegeben werden.

PscAutoConnection

Details zu Nutzerressourcen in einer PSC-Verbindung.

JSON-Darstellung 
{
  "pscConnectionId": string,
  "ipAddress": string,
  "forwardingRule": string,
  "projectId": string,
  "network": string
}
Felder
pscConnectionId

string

Nur Ausgabe. Die PSC-Verbindungs-ID der Weiterleitungsregel, die mit dem Dienstanhang verbunden ist.
ipAddress

string

Nur Ausgabe. Die IP-Adresse, die im Nutzernetzwerk für die PSC-Weiterleitungsregel zugewiesen ist.
forwardingRule

string

Nur Ausgabe. Der URI der Weiterleitungsregel auf Verbraucherseite. Format: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
projectId

string

Erforderlich. Die Nutzerprojekt-ID, aus der die Weiterleitungsregel erstellt wird.
network

string

Erforderlich. Das Nutzernetzwerk, in dem sich die IP-Adresse befindet, im Format „projects/{projectId}/global/networks/{network_id}“.

Methoden

create

 Erstellt eine neue Instanz in einem angegebenen Projekt und an einem angegebenen Ort.

delete

 Löscht eine einzelne Instanz.

get

 Ruft Details zu einer einzelnen Instanz ab.

getCertificateAuthority

 Ruft Details zur Zertifizierungsstelle für eine Instanz ab.

list

 Listet Instanzen in einem angegebenen Projekt und an einem angegebenen Standort auf.

patch

 Aktualisiert die Parameter einer einzelnen Instanz.