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)
    }
  ],
  "endpoints": [
    {
      object (InstanceEndpoint)
    }
  ],
  "mode": enum (Mode),
  "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. Der Erstellungszeitstempel 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. Der 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

Optional. 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. Von Nutzern 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 einzelner Knoten der Instanz.
zoneDistributionConfig

object (ZoneDistributionConfig)

Optional. Nicht veränderbar. Zonenverteilungskonfiguration der Instanz für die Knotenzuordnung.
pscAutoConnections[]

object (PscAutoConnection)

Pflichtangabe. Nicht veränderbar. Nutzereingaben und Ressourcendetails der automatisch erstellten PSC-Verbindungen.
endpoints[]

object (InstanceEndpoint)

Optional. Endpunkte für die Instanz.
mode

enum (Mode)

Optional. Die Moduskonfiguration für die Instanz.
replicaCount

integer

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

boolean

Optional. Wenn diese Option auf „wahr“ 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 eine laufende Aktualisierung, wenn der Instanzstatus UPDATING ist.

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 IAM-Grundautorisierung.

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 freigegebenen Endpunkts, zu dem Clients eine Verbindung herstellen.
port

integer

Nur Ausgabe. Die Portnummer des freigegebenen 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 Speichermedium mit großem Speicher.
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 wird deaktiviert und alle Snapshot-Daten werden gelöscht.
RDB Die RDB-basierte Persistenz ist aktiviert.
AOF Die 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. Der 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 jede Sekunde. Bei einem Notfallereignis können Sie bis zu 1 Sekunde an Daten 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

Zonenverteilungskonfiguration 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 im Modus „MULTI_ZONE“ ignoriert.
mode

enum (ZoneDistributionMode)

Optional. Aktueller Zonenverteilungsmodus. Die Standardeinstellung ist MULTI_ZONE.

ZoneDistributionMode

Mögliche Zonenverteilungsmodi

Enums
ZONE_DISTRIBUTION_MODE_UNSPECIFIED Nicht festgelegt. Standardeinstellung: MULTI_ZONE
MULTI_ZONE Ressourcen auf drei zufällig ausgewählte Zonen innerhalb der Region verteilen
SINGLE_ZONE Ressourcen in einer einzelnen Zone bereitstellen. 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,
  "serviceAttachment": string,
  "pscConnectionStatus": enum (PscConnectionStatus),
  "connectionType": enum (ConnectionType),

  // Union field ports can be only one of the following:
  "port": integer
  // End of list of possible types for union field ports.
}
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

Pflichtangabe. Die Projekt-ID des Nutzers, für den PSC-Verbindungen hergestellt werden. Dies sollte die Projekt-ID sein, in der die Instanz erstellt wird.
network

string

Pflichtangabe. Das Netzwerk, in dem die PSC-Endpunkte erstellt werden, im Format „projects/{projectId}/global/networks/{network_id}“.
serviceAttachment

string

Nur Ausgabe. Der Dienstanhang, der das Ziel der PSC-Verbindung ist, im Format projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}.
pscConnectionStatus

enum (PscConnectionStatus)

Nur Ausgabe. Der Status der PSC-Verbindung: Gibt an, ob eine Verbindung vorhanden und AKTIV ist oder nicht mehr vorhanden ist. Dieser Wert wird regelmäßig aktualisiert. Aktuelle Informationen zum Status erhalten Sie über die Private Service Connect APIs.
connectionType

enum (ConnectionType)

Nur Ausgabe. Art der PSC-Verbindung.
Union-Feld ports. Ports des freigegebenen Endpunkts. Für ports ist nur einer der folgenden Werte zulässig:
port

integer

Optional. Nur Ausgabe. „port“ wird nur für den primären/Lesegerät- oder Discovery-Endpunkt festgelegt.

PscConnectionStatus

Status der PSC-Verbindung.

Enums
PSC_CONNECTION_STATUS_UNSPECIFIED Der PSC-Verbindungsstatus ist nicht angegeben.
ACTIVE Die Verbindung ist aktiv
NOT_FOUND Keine Verbindung gefunden

ConnectionType

Typ einer PSC-Verbindung

Enums
CONNECTION_TYPE_UNSPECIFIED Verbindungstyp nicht festgelegt
CONNECTION_TYPE_DISCOVERY Verbindung, die für die Topologieerkennung verwendet wird.
CONNECTION_TYPE_PRIMARY Verbindung, die als primärer Endpunkt für den Zugriff auf den primären verwendet wird.
CONNECTION_TYPE_READER Verbindung, die als Leserendpunkt zum Zugriff auf Replikate verwendet wird.

InstanceEndpoint

„InstanceEndpoint“ besteht aus PSC-Verbindungen, die für den Zugriff auf die Instanz in jedem VPC-Netzwerk als Gruppe erstellt werden. In jeder Gruppe muss es eine Verbindung für jeden Dienstanschluss im Cluster geben.

JSON-Darstellung 
{
  "connections": [
    {
      object (ConnectionDetail)
    }
  ]
}
Felder
connections[]

object (ConnectionDetail)

Optional. Eine Gruppe von PSC-Verbindungen. Sie werden im selben VPC-Netzwerk erstellt, jeweils eine für jeden Dienstanhang im Cluster.

ConnectionDetail

Informationen zu jeder PSC-Verbindung.

JSON-Darstellung 
{

  // Union field connection can be only one of the following:
  "pscAutoConnection": {
    object (PscAutoConnection)
  },
  "pscConnection": {
    object (PscConnection)
  }
  // End of list of possible types for union field connection.
}
Felder
Union-Feld connection. Eine PSC-Verbindung zu einer Instanz kann entweder während der Clustererstellung über die Automatisierung der Dienstverbindung (automatische Verbindung) oder vom Kunden selbst (vom Nutzer erstellte Verbindung) erstellt werden. Für connection ist nur einer der folgenden Werte zulässig:
pscAutoConnection

object (PscAutoConnection)

Detaillierte Informationen zu einer PSC-Verbindung, die über die Automatisierung von Dienstverbindungen erstellt wird.
pscConnection

object (PscConnection)

Detaillierte Informationen zu einer PSC-Verbindung, die vom Nutzer erstellt wurde.

PscConnection

Vom Nutzer erstellte PSC-Verbindungskonfiguration.

JSON-Darstellung 
{
  "pscConnectionId": string,
  "ipAddress": string,
  "forwardingRule": string,
  "projectId": string,
  "network": string,
  "serviceAttachment": string,
  "pscConnectionStatus": enum (PscConnectionStatus),
  "connectionType": enum (ConnectionType)
}
Felder
pscConnectionId

string

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

string

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

string

Pflichtangabe. Der URI der Weiterleitungsregel auf der Seite des Verbrauchers. Format: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
projectId

string

Nur Ausgabe. Die Projekt-ID des Nutzers, in dem die Weiterleitungsregel erstellt wird.
network

string

Pflichtangabe. Das Netzwerk des Nutzers, in dem sich die IP-Adresse befindet, im Format projects/{projectId}/global/networks/{network_id}.
serviceAttachment

string

Pflichtangabe. Der Dienstanhang, der das Ziel der PSC-Verbindung ist, im Format projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}.
pscConnectionStatus

enum (PscConnectionStatus)

Nur Ausgabe. Der Status der PSC-Verbindung: Gibt an, ob eine Verbindung vorhanden und AKTIV ist oder nicht mehr vorhanden ist. Dieser Wert wird regelmäßig aktualisiert. Aktuelle Informationen zum Status erhalten Sie über die Private Service Connect APIs.
connectionType

enum (ConnectionType)

Nur Ausgabe. Art der PSC-Verbindung.

Modus

Die Moduskonfiguration, mit der der Clustermodus aktiviert oder deaktiviert wird.

Enums
MODE_UNSPECIFIED Der Modus ist nicht angegeben.
CLUSTER Die Instanz befindet sich im Clustermodus.
CLUSTER_DISABLED Der Clustermodus ist für die Instanz deaktiviert.

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.