REST-Ressource: projects.locations.instances

Ressource: Instanz

Eine Google Cloud Redis-Instanz

JSON-Darstellung 

{
  "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
}
Felder
name

string

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

Hinweis: Redis-Instanzen werden auf regionaler Ebene verwaltet und adressiert. Die Zonen-ID bezieht sich somit auf die GCP-Region; Nutzer können jedoch auswählen, in welcher Zone bzw. in welchen Zonen (bei zonenübergreifenden Instanzen) eine Instanz bereitgestellt wird. Weitere Informationen finden Sie in den Feldern [locationId] und [alternativeLocationId].
displayName

string

Ein beliebiger und optional vom Nutzer bereitgestellter Name für die Instanz.

labels

map (key: string, value: string)

Ressourcenetiketten zur Darstellung der vom Nutzer bereitgestellten Metadaten.

Ein Objekt mit einer Liste der Paare "key": value. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }
locationId

string

Optional. Die Zone, in der die Instanz bereitgestellt wird. Wenn nicht angegeben, wählt der Dienst eine Zone für die Instanz aus. Für die Stufe STANDARD_HA werden Instanzen in zwei Zonen erstellt. Hierdurch ist die Instanz vor zonalen Ausfällen geschützt. [alternativeLocationId] muss sich von [locationId] unterscheiden. sofern angegeben

alternativeLocationId

string

Optional. Gilt nur für die Stufe STANDARD_HA, die die Instanz vor zonalen Ausfällen schützt, indem sie in zwei Zonen bereitgestellt wird. Falls angegeben, muss es sich um eine andere Zone als die in [locationId] angegebene Zone handeln.

redisVersion

string

Optional. Die Version der Redis-Software. Wenn nicht angegeben, wird die neueste unterstützte Version verwendet. Durch das Aktualisieren der Version wird ein Upgrade/Downgrade auf die neue Version durchgeführt. Derzeit werden für Redis 3.2 die Werte REDIS_3_2 unterstützt.

reservedIpRange

string

Optional. Der CIDR-Bereich interner Adressen, die für diese Instanz reserviert sind. Wenn nicht angegeben, wählt der Dienst einen unbenutzten /29-Block aus, z. B. 10.0.0.0/29 oder 192.168.0.0/29. Bereiche müssen eindeutig sein und dürfen sich nicht mit vorhandenen Subnetzen in einem autorisierten Netzwerk überschneiden.

host

string

Nur Ausgabe. Hostname oder IP-Adresse des exponierten Redis-Endpunkts, der von Clients zum Herstellen einer Verbindung mit dem Dienst verwendet wird.

port

number

Nur Ausgabe. Die Portnummer des exponierten Redis-Endpunkts.

currentLocationId

string

Nur Ausgabe. Die aktuelle Zone, in der der Redis-Endpunkt platziert wird. Für Instanzen der Basisstufe entspricht dies immer der [locationId], die der Nutzer zum Zeitpunkt der Erstellung angibt. Für Instanzen der Standardstufe kann dies entweder [locationId] oder [alternativeLocationId] sein und sich nach einem Failover-Ereignis ändern.

createTime

string (Timestamp format)

Nur Ausgabe. Die Uhrzeit, zu der die Instanz erstellt wurde.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" in Nanosekunden. Beispiel: "2014-10-02T15:01:23.045123456Z"
state

enum(State)

Nur Ausgabe. Der aktuelle Status dieser Instanz.

statusMessage

string

Nur Ausgabe. Weitere Informationen zum aktuellen Status dieser Instanz, falls verfügbar.

redisConfigs

map (key: string, value: string)

Optional. Redis-Konfigurationsparameter gemäß http://redis.io/topics/config. Derzeit werden nur folgende Parameter unterstützt:

  • maxmemory-policy
  • notify-keyspace-events

Ein Objekt mit einer Liste der Paare "key": value. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }
tier

enum(Tier)

Erforderlich. Die Dienststufe der Instanz.

memorySizeGb

number

Erforderlich. Redis-Speichergröße in GiB.

authorizedNetwork

string

Optional. Der vollständige Name des Google Compute Engine-Netzwerks, mit dem die Instanz verbunden ist. Wenn nicht angegeben, wird default verwendet.

persistenceIamIdentity

string

Nur Ausgabe. IAM-Identität, die von Import-/Exportvorgängen verwendet wird, um Daten an/von GCS zu übertragen. Das Format ist "serviceAccount:". Der Wert kann sich im Laufe der Zeit für eine bestimmte Instanz ändern und sollte daher vor jedem Import-/Exportvorgang überprüft werden.

Status

Stellt die verschiedenen Status einer Redis-Instanz dar.

Enums
STATE_UNSPECIFIED Nicht definiert.
CREATING Redis-Instanz wird erstellt.
READY Redis-Instanz wurde erstellt und ist vollständig nutzbar.
UPDATING Redis-Instanzkonfiguration wird aktualisiert. Bestimmte Arten von Aktualisierungen können dazu führen, dass die Instanz während des Aktualisierungsvorgangs unbrauchbar wird.
DELETING Redis-Instanz wird gelöscht.
REPAIRING Redis-Instanz wird repariert und kann möglicherweise nicht verwendet werden. Details finden Sie im Feld statusMessage.
MAINTENANCE Redis-Instanz befindet sich im Wartungsmodus.
IMPORTING Redis-Instanz importiert Daten. Die Verfügbarkeit ist möglicherweise beeinträchtigt.

Stufe

Verfügbare Dienststufen

Enums
TIER_UNSPECIFIED Nicht definiert.
BASIC Stufe BASIC: eigenständige Instanz.
STANDARD_HA Stufe STANDARD_HA: hoch verfügbare Primär-/Replikatinstanzen.

Methoden

create

 Erstellt eine Redis-Instanz basierend auf der angegebenen Stufe und Speichergröße.

delete

 Löscht eine bestimmte Redis-Instanz.

get

 Ruft die Details einer bestimmten Redis-Instanz ab.

list

 Listet alle Redis-Instanzen auf, die einem Projekt entweder in der angegebenen Zone (Region) oder in allen Zonen zugehörig sind.

patch

 Aktualisiert die Metadaten und die Konfiguration einer bestimmten Redis-Instanz.