MCP Tools Reference: redis.googleapis.com

Tool: create_cluster

Erstellen Sie einen Cluster in Memorystore for Redis Cluster.

Im folgenden Beispiel wird gezeigt, wie Sie mit curl das MCP-Tool create_cluster aufrufen.

Curl-Anfrage 
                  
curl --location 'https://redis.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "create_cluster",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Eingabeschema

Anfrage für CreateCluster.

CreateClusterRequest

JSON-Darstellung 
{
  "parent": string,
  "clusterId": string,
  "cluster": {
    object (Cluster)
  },
  "requestId": string
}
Felder
parent

string

Erforderlich. Der Ressourcenname des Clusterstandorts im Format projects/{project_id}/locations/{location_id}, wobei sich location_id auf eine Google Cloud-Region bezieht.
clusterId

string

Erforderlich. Der logische Name des Redis-Clusters im Kundenprojekt mit den folgenden Einschränkungen:

  • Darf nur Kleinbuchstaben, Ziffern und Bindestriche enthalten.
  • Muss mit einem Buchstaben beginnen
  • Muss 1–63 Zeichen umfassen
  • Muss mit einer Zahl oder einem Buchstaben enden
  • Darf innerhalb des Kundenprojekts bzw. der Zone nur einmal vorkommen
cluster

object (Cluster)

Erforderlich. Der Cluster, der erstellt werden soll.
requestId

string

Optional. UUID für idempotente Anfrage.

Cluster

JSON-Darstellung 
{
  "name": string,
  "createTime": string,
  "state": enum (State),
  "uid": string,
  "authorizationMode": enum (AuthorizationMode),
  "transitEncryptionMode": enum (TransitEncryptionMode),
  "pscConfigs": [
    {
      object (PscConfig)
    }
  ],
  "discoveryEndpoints": [
    {
      object (DiscoveryEndpoint)
    }
  ],
  "pscConnections": [
    {
      object (PscConnection)
    }
  ],
  "stateInfo": {
    object (StateInfo)
  },
  "nodeType": enum (NodeType),
  "persistenceConfig": {
    object (ClusterPersistenceConfig)
  },
  "redisConfigs": {
    string: string,
    ...
  },
  "zoneDistributionConfig": {
    object (ZoneDistributionConfig)
  },
  "crossClusterReplicationConfig": {
    object (CrossClusterReplicationConfig)
  },
  "pscServiceAttachments": [
    {
      object (PscServiceAttachment)
    }
  ],
  "clusterEndpoints": [
    {
      object (ClusterEndpoint)
    }
  ],
  "automatedBackupConfig": {
    object (AutomatedBackupConfig)
  },
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "availableMaintenanceVersions": [
    string
  ],
  "allowFewerZonesDeployment": boolean,
  "labels": {
    string: string,
    ...
  },
  "aclPolicy": string,

  // Union field import_sources can be only one of the following:
  "gcsSource": {
    object (GcsBackupSource)
  },
  "managedBackupSource": {
    object (ManagedBackupSource)
  }
  // End of list of possible types for union field import_sources.

  // Union field _replica_count can be only one of the following:
  "replicaCount": integer
  // End of list of possible types for union field _replica_count.

  // Union field _size_gb can be only one of the following:
  "sizeGb": integer
  // End of list of possible types for union field _size_gb.

  // Union field _shard_count can be only one of the following:
  "shardCount": integer
  // End of list of possible types for union field _shard_count.

  // Union field _precise_size_gb can be only one of the following:
  "preciseSizeGb": number
  // End of list of possible types for union field _precise_size_gb.

  // Union field _deletion_protection_enabled can be only one of the following:
  "deletionProtectionEnabled": boolean
  // End of list of possible types for union field _deletion_protection_enabled.

  // Union field _maintenance_policy can be only one of the following:
  "maintenancePolicy": {
    object (ClusterMaintenancePolicy)
  }
  // End of list of possible types for union field _maintenance_policy.

  // Union field _maintenance_schedule can be only one of the following:
  "maintenanceSchedule": {
    object (ClusterMaintenanceSchedule)
  }
  // End of list of possible types for union field _maintenance_schedule.

  // Union field _satisfies_pzs can be only one of the following:
  "satisfiesPzs": boolean
  // End of list of possible types for union field _satisfies_pzs.

  // Union field _satisfies_pzi can be only one of the following:
  "satisfiesPzi": boolean
  // End of list of possible types for union field _satisfies_pzi.

  // Union field _simulate_maintenance_event can be only one of the following:
  "simulateMaintenanceEvent": boolean
  // End of list of possible types for union field _simulate_maintenance_event.

  // Union field _backup_collection can be only one of the following:
  "backupCollection": string
  // End of list of possible types for union field _backup_collection.

  // Union field _kms_key can be only one of the following:
  "kmsKey": string
  // End of list of possible types for union field _kms_key.

  // Union field _ondemand_maintenance can be only one of the following:
  "ondemandMaintenance": boolean
  // End of list of possible types for union field _ondemand_maintenance.

  // Union field _async_cluster_endpoints_deletion_enabled can be only one of the
  // following:
  "asyncClusterEndpointsDeletionEnabled": boolean
  // End of list of possible types for union field
  // _async_cluster_endpoints_deletion_enabled.

  // Union field _maintenance_version can be only one of the following:
  "maintenanceVersion": string
  // End of list of possible types for union field _maintenance_version.

  // Union field _effective_maintenance_version can be only one of the following:
  "effectiveMaintenanceVersion": string
  // End of list of possible types for union field
  // _effective_maintenance_version.

  // Union field _server_ca_mode can be only one of the following:
  "serverCaMode": enum (ServerCaMode)
  // End of list of possible types for union field _server_ca_mode.

  // Union field _server_ca_pool can be only one of the following:
  "serverCaPool": string
  // End of list of possible types for union field _server_ca_pool.

  // Union field _rotate_server_certificate can be only one of the following:
  "rotateServerCertificate": boolean
  // End of list of possible types for union field _rotate_server_certificate.

  // Union field _acl_policy_in_sync can be only one of the following:
  "aclPolicyInSync": boolean
  // End of list of possible types for union field _acl_policy_in_sync.
}
Felder
name

string

Erforderlich. ID. Eindeutiger Name der Ressource in diesem Bereich, einschließlich Projekt und Standort, die folgendes Format haben: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}
createTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel, der der Anfrage zur Clustererstellung zugeordnet ist.

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 aktuelle Status dieses Clusters. Kann CREATING, READY, UPDATING, DELETING und SUSPENDED sein
uid

string

Nur Ausgabe. Vom System zugewiesene eindeutige Kennung für den Cluster.
authorizationMode

enum (AuthorizationMode)

Optional. Der Autorisierungsmodus des Redis-Clusters. Wenn nicht angegeben, ist die Authentifizierungsfunktion für den Cluster deaktiviert.
transitEncryptionMode

enum (TransitEncryptionMode)

Optional. Die Verschlüsselung während der Übertragung für den Redis-Cluster. Wenn nicht angegeben, ist die Verschlüsselung für den Cluster deaktiviert.
pscConfigs[]

object (PscConfig)

Optional. Jede PscConfig konfiguriert das Nutzer-Netzwerk, in dem IP-Adressen dem Cluster für den Clientzugriff über die Private Service Connect-Automatisierung zugewiesen werden. Derzeit wird nur eine PscConfig unterstützt.
discoveryEndpoints[]

object (DiscoveryEndpoint)

Nur Ausgabe. Endpunkte, die in jedem angegebenen Netzwerk erstellt werden, damit Redis-Clients eine Verbindung zum Cluster herstellen können. Derzeit wird nur ein Discovery-Endpunkt unterstützt.
pscConnections[]

object (PscConnection)

Nur Ausgabe. Die Liste der PSC-Verbindungen, die durch die Automatisierung von Dienstverbindungen automatisch erstellt werden.
stateInfo

object (StateInfo)

Nur Ausgabe. Zusätzliche Informationen zum aktuellen Status des Clusters.
nodeType

enum (NodeType)

Optional. Der Typ eines Redis-Knotens im Cluster. NodeType bestimmt den zugrunde liegenden Maschinentyp eines Redis-Knotens.
persistenceConfig

object (ClusterPersistenceConfig)

Optional. Konfiguration der Persistenz (RDB, AOF) für den Cluster.
redisConfigs

map (key: string, value: string)

Optional. Schlüssel/Wert-Paare für Kundenüberschreibungen für veränderliche Redis-Konfigurationen

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

object (ZoneDistributionConfig)

Optional. Mit dieser Konfiguration wird festgelegt, wie Clusterressourcen in der Region verteilt werden sollen.
crossClusterReplicationConfig

object (CrossClusterReplicationConfig)

Optional. Konfiguration der clusterübergreifenden Replikation.
pscServiceAttachments[]

object (PscServiceAttachment)

Nur Ausgabe. Details zum Dienstanhang zum Konfigurieren von PSC-Verbindungen
clusterEndpoints[]

object (ClusterEndpoint)

Optional. Eine Liste der Clusterendpunkte.
automatedBackupConfig

object (AutomatedBackupConfig)

Optional. Die Konfiguration für automatische Sicherungen für den Cluster.
encryptionInfo

object (EncryptionInfo)

Nur Ausgabe. Verschlüsselungsinformationen der ruhenden Daten des Clusters.
availableMaintenanceVersions[]

string

Nur Ausgabe. Anhand dieses Felds werden die verfügbaren Wartungsversionen für das Selfservice-Update ermittelt.
allowFewerZonesDeployment
(deprecated)

boolean

Optional. Nicht veränderbar. Veraltet, nicht verwenden.
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" }.
aclPolicy

string

Optional. Die ACL-Richtlinie, die auf den Cluster angewendet werden soll.
Union-Feld import_sources. Die Quelle, aus der importiert werden soll. Für import_sources ist nur einer der folgenden Werte zulässig:
gcsSource

object (GcsBackupSource)

Optional. Sicherungen, die in Cloud Storage-Buckets gespeichert sind Die Cloud Storage-Buckets müssen sich in derselben Region wie die Cluster befinden. Zum Importieren aus den bereitgestellten Cloud Storage-Objekten ist die Leseberechtigung erforderlich.
managedBackupSource

object (ManagedBackupSource)

Optional. Sicherungen, die vom Memorystore-Dienst generiert und verwaltet werden.

Union-Feld _replica_count.

Für _replica_count ist nur einer der folgenden Werte zulässig:
replicaCount

integer

Optional. Die Anzahl der Replikatknoten pro Shard.

Union-Feld _size_gb.

Für _size_gb ist nur einer der folgenden Werte zulässig:
sizeGb

integer

Nur Ausgabe. Die Redis-Arbeitsspeichergröße in GB für den gesamten Cluster, auf die nächste Ganzzahl aufgerundet.

Union-Feld _shard_count.

Für _shard_count ist nur einer der folgenden Werte zulässig:
shardCount

integer

Optional. Anzahl der Shards für den Redis-Cluster.

Union-Feld _precise_size_gb.

Für _precise_size_gb ist nur einer der folgenden Werte zulässig:
preciseSizeGb

number

Nur Ausgabe. Genaue Größe des Redis-Arbeitsspeichers in GB für den gesamten Cluster.

Union-Feld _deletion_protection_enabled.

Für _deletion_protection_enabled ist nur einer der folgenden Werte zulässig:
deletionProtectionEnabled

boolean

Optional. Der Löschvorgang schlägt fehl, wenn der Wert auf „true“ gesetzt ist.

Union-Feld _maintenance_policy.

Für _maintenance_policy ist nur einer der folgenden Werte zulässig:
maintenancePolicy

object (ClusterMaintenancePolicy)

Optional. ClusterMaintenancePolicy bestimmt, wann Updates zugelassen oder abgelehnt werden.

Union-Feld _maintenance_schedule.

Für _maintenance_schedule ist nur einer der folgenden Werte zulässig:
maintenanceSchedule

object (ClusterMaintenanceSchedule)

Nur Ausgabe. ClusterMaintenanceSchedule Nur Ausgabe Veröffentlichter Wartungsplan.

Union-Feld _satisfies_pzs.

Für _satisfies_pzs ist nur einer der folgenden Werte zulässig:
satisfiesPzs

boolean

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

Union-Feld _satisfies_pzi.

Für _satisfies_pzi ist nur einer der folgenden Werte zulässig:
satisfiesPzi

boolean

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

Union-Feld _simulate_maintenance_event.

Für _simulate_maintenance_event ist nur einer der folgenden Werte zulässig:
simulateMaintenanceEvent

boolean

Optional. Nur Eingabe. Wartungsereignis simulieren

Union-Feld _backup_collection.

Für _backup_collection ist nur einer der folgenden Werte zulässig:
backupCollection

string

Optional. Nur Ausgabe. Der vollständige Ressourcenname der Sicherungssammlung. Beispiel: projects/{project}/locations/{location}/backupCollections/{collection}

Union-Feld _kms_key.

Für _kms_key ist nur einer der folgenden Werte zulässig:
kmsKey

string

Optional. Der KMS-Schlüssel, der zum Verschlüsseln der ruhenden Daten des Clusters verwendet wird.

Union-Feld _ondemand_maintenance.

Für _ondemand_maintenance ist nur einer der folgenden Werte zulässig:
ondemandMaintenance
(deprecated)

boolean

Optional. Nur Eingabe. Bedarfsgesteuerte Wartung für den Cluster. Mit diesem Feld kann ein On-Demand-Update für kritische Sicherheitslücken im Cluster ausgelöst werden.

Union-Feld _async_cluster_endpoints_deletion_enabled.

Für _async_cluster_endpoints_deletion_enabled ist nur einer der folgenden Werte zulässig:
asyncClusterEndpointsDeletionEnabled

boolean

Optional. Bei „true“ können Clusterendpunkte, die von Kunden erstellt und registriert wurden, asynchron gelöscht werden. Das bedeutet, dass ein solcher Clusterendpunkt abgemeldet werden kann, bevor die Weiterleitungsregeln im Clusterendpunkt gelöscht werden.

Union-Feld _maintenance_version.

Für _maintenance_version ist nur einer der folgenden Werte zulässig:
maintenanceVersion

string

Optional. Mit diesem Feld kann ein Selfservice-Update ausgelöst werden, um die gewünschte Wartungsversion anzugeben. Die Eingabe für dieses Feld kann durch das Feld „available_maintenance_versions“ bestimmt werden.

Union-Feld _effective_maintenance_version.

Für _effective_maintenance_version ist nur einer der folgenden Werte zulässig:
effectiveMaintenanceVersion

string

Nur Ausgabe. Dieses Feld gibt die tatsächliche Wartungsversion des Clusters an.

Union-Feld _server_ca_mode.

Für _server_ca_mode ist nur einer der folgenden Werte zulässig:
serverCaMode

enum (ServerCaMode)

Optional. Modus für Serverzertifizierungsstellen für den Cluster.

Union-Feld _server_ca_pool.

Für _server_ca_pool ist nur einer der folgenden Werte zulässig:
serverCaPool

string

Optional. Kundenverwalteter Zertifizierungsstellenpool für den Cluster. Gilt nur für BYOCA, d.h. wenn server_ca_mode SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA ist. Format: „projects/{project}/locations/{region}/caPools/{ca_pool}“.

Union-Feld _rotate_server_certificate.

Für _rotate_server_certificate ist nur einer der folgenden Werte zulässig:
rotateServerCertificate

boolean

Optional. Nur Eingabe. Rotieren Sie die Serverzertifikate.

Union-Feld _acl_policy_in_sync.

Für _acl_policy_in_sync ist nur einer der folgenden Werte zulässig:
aclPolicyInSync

boolean

Optional. Nur Ausgabe. Gibt an, ob die auf den Cluster angewendeten ACL-Regeln mit den neuesten ACL-Richtlinienregeln synchronisiert sind. Dieses Feld ist nur anwendbar, wenn die ACL-Richtlinie für den Cluster festgelegt ist.

GcsBackupSource

JSON-Darstellung 
{
  "uris": [
    string
  ]
}
Felder
uris[]

string

Optional. URIs der zu importierenden Cloud Storage-Objekte. Beispiel: gs://bucket1/object1, gs://bucket2/folder2/object2

ManagedBackupSource

JSON-Darstellung 
{
  "backup": string
}
Felder
backup

string

Optional. Beispiel: //redis.googleapis.com/projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup} Eine kürzere Version (ohne das Präfix) des Sicherungsnamens wird ebenfalls unterstützt, z. B. projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup_id}. In diesem Fall wird davon ausgegangen, dass sich die Sicherung unter redis.googleapis.com befindet.

Zeitstempel

JSON-Darstellung 
{
  "seconds": string,
  "nanos": integer
}
Felder
seconds

string (int64 format)

Stellt Sekunden der UTC-Zeit seit Unix-Epoche 1970-01-01T00:00:00Z dar. Muss einschließlich zwischen -62135596800 und 253402300799 liegen (entspricht 0001-01-01T00:00:00Z bis 9999-12-31T23:59:59Z).
nanos

integer

Nicht negative Sekundenbruchteile Nanosekunden-Auflösung. Dieses Feld enthält den Nanosekundenanteil der Dauer und ist keine Alternative zu Sekunden. Negative Sekundenwerte mit Bruchteilen müssen weiterhin nicht negative Nano-Werte haben, die zeitlich vorwärts gezählt werden. Muss zwischen 0 und 999.999.999 liegen (einschließlich).

PscConfig

JSON-Darstellung 
{
  "network": string
}
Felder
network

string

Erforderlich. Das Netzwerk, in dem die IP-Adresse des Discovery-Endpunkts reserviert wird, im Format „projects/{network_project}/global/networks/{network_id}“.

DiscoveryEndpoint

JSON-Darstellung 
{
  "address": string,
  "port": integer,
  "pscConfig": {
    object (PscConfig)
  }
}
Felder
address

string

Nur Ausgabe. Adresse des bereitgestellten Redis-Endpunkts, über den Clients eine Verbindung zum Dienst herstellen. Die Adresse kann entweder eine IP-Adresse oder ein Hostname sein.
port

integer

Nur Ausgabe. Die Portnummer des exponierten Redis-Endpunkts.
pscConfig

object (PscConfig)

Nur Ausgabe. Kundenkonfiguration für den Ort, an dem der Endpunkt erstellt wird und auf den zugegriffen wird.

PscConnection

JSON-Darstellung 
{
  "pscConnectionId": string,
  "address": 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

Erforderlich. Die PSC-Verbindungs-ID der Weiterleitungsregel, die mit dem Dienstanhang verbunden ist.
address

string

Erforderlich. Die IP-Adresse, die im Netzwerk des Nutzers für die PSC-Weiterleitungsregel zugewiesen ist.
forwardingRule

string

Erforderlich. Der URI der Weiterleitungsregel auf der Consumer-Seite. Beispiel: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}.
projectId

string

Optional. Projekt-ID des Nutzerprojekts, in dem die Weiterleitungsregel erstellt wird.
network

string

Erforderlich. Das Netzwerk des Dienstnutzers, in dem sich die IP-Adresse befindet, im Format „projects/{project_id}/global/networks/{network_id}“.
serviceAttachment

string

Erforderlich. 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. Dieser Wert wird regelmäßig aktualisiert. Den aktuellen Status einer PSC-Verbindung finden Sie unter https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details.
connectionType

enum (ConnectionType)

Nur Ausgabe. Typ der PSC-Verbindung.
Union-Feld ports. Die Portnummer des bereitgestellten Erkennungs-Endpunkts. Für ports ist nur einer der folgenden Werte zulässig:
port

integer

Nur Ausgabe. Der Port wird nur für den primären Endpunkt, den Leseendpunkt oder den Discovery-Endpunkt festgelegt.

StateInfo

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)

Beschreibt laufende Updates für den Cluster, wenn der Clusterstatus UPDATING ist.

UpdateInfo

JSON-Darstellung 
{

  // Union field _target_shard_count can be only one of the following:
  "targetShardCount": integer
  // End of list of possible types for union field _target_shard_count.

  // Union field _target_replica_count can be only one of the following:
  "targetReplicaCount": integer
  // End of list of possible types for union field _target_replica_count.

  // Union field _target_node_type can be only one of the following:
  "targetNodeType": enum (NodeType)
  // End of list of possible types for union field _target_node_type.
}
Felder

Union-Feld _target_shard_count.

Für _target_shard_count ist nur einer der folgenden Werte zulässig:
targetShardCount

integer

Zielanzahl der Shards für den Redis-Cluster

Union-Feld _target_replica_count.

Für _target_replica_count ist nur einer der folgenden Werte zulässig:
targetReplicaCount

integer

Zielanzahl der Replikatknoten pro Shard.

Union-Feld _target_node_type.

Für _target_node_type ist nur einer der folgenden Werte zulässig:
targetNodeType

enum (NodeType)

Zielknotentyp für Redis-Cluster.

ClusterPersistenceConfig

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

enum (PersistenceMode)

Optional. Der 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.

RDBConfig

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

enum (SnapshotPeriod)

Optional. Zeitraum zwischen RDB-Snapshots.
rdbSnapshotStartTime

string (Timestamp format)

Optional. Die Zeit, zu der der erste Snapshot erstellt wurde bzw. wird und an der zukünftige Snapshots ausgerichtet werden. Wenn nicht angegeben, wird die aktuelle Zeit verwendet.

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

AOFConfig

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

enum (AppendFsync)

Optional. fsync-Konfiguration.

RedisConfigsEntry

JSON-Darstellung 
{
  "key": string,
  "value": string
}
Felder
key

string
value

string

ZoneDistributionConfig

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

enum (ZoneDistributionMode)

Optional. Der Modus der Zonenverteilung. Wenn keine Angabe gemacht wird, ist der Standardwert MULTI_ZONE.
zone

string

Optional. Wenn die Verteilung auf eine einzelne Zone ausgewählt ist, wird das Zonenfeld verwendet, um alle Ressourcen in dieser Zone zuzuweisen. Dies gilt nicht für MULTI_ZONE-Cluster und wird für diese ignoriert.

CrossClusterReplicationConfig

JSON-Darstellung 
{
  "clusterRole": enum (ClusterRole),
  "primaryCluster": {
    object (RemoteCluster)
  },
  "secondaryClusters": [
    {
      object (RemoteCluster)
    }
  ],
  "updateTime": string,
  "membership": {
    object (Membership)
  }
}
Felder
clusterRole

enum (ClusterRole)

Nur Ausgabe. Die Rolle des Clusters bei der clusterübergreifenden Replikation.
primaryCluster

object (RemoteCluster)

Details des primären Clusters, der als Replikationsquelle für diesen sekundären Cluster verwendet wird.

Dieses Feld wird nur für einen sekundären Cluster festgelegt.
secondaryClusters[]

object (RemoteCluster)

Liste der sekundären Cluster, die aus diesem primären Cluster repliziert werden.

Dieses Feld wird nur für einen primären Cluster festgelegt.
updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt der letzten Aktualisierung der Konfiguration für die clusterübergreifende Replikation.

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

object (Membership)

Nur Ausgabe. Eine reine Ausgabeansicht aller Mitgliedscluster, die an der clusterübergreifenden Replikation teilnehmen. Diese Ansicht wird von jedem Mitgliedscluster bereitgestellt, unabhängig von seiner Clusterrolle(primär oder sekundär).

Ein primärer Cluster kann Informationen zu allen sekundären Clustern liefern, die Daten daraus replizieren. Ein sekundärer Cluster kennt jedoch nur den primären Cluster, aus dem er repliziert wird. In Szenarien, in denen der primäre Cluster nicht verfügbar ist(z. B. bei einem regionalen Ausfall), kann eine GetCluster-Anfrage an einen beliebigen anderen Mitgliedscluster gesendet werden. In diesem Feld werden alle Mitgliedscluster aufgeführt, die an der clusterübergreifenden Replikation beteiligt sind.

RemoteCluster

JSON-Darstellung 
{
  "cluster": string,
  "uid": string
}
Felder
cluster

string

Nur Ausgabe. Der vollständige Ressourcenpfad des Remote-Clusters im Format: projects//locations//clusters/
uid

string

Nur Ausgabe. Die eindeutige ID des Remote-Clusters.

Mitgliedschaft

JSON-Darstellung 
{
  "primaryCluster": {
    object (RemoteCluster)
  },
  "secondaryClusters": [
    {
      object (RemoteCluster)
    }
  ]
}
Felder
primaryCluster

object (RemoteCluster)

Nur Ausgabe. Der primäre Cluster, der als Replikationsquelle für die sekundären Cluster dient.
secondaryClusters[]

object (RemoteCluster)

Nur Ausgabe. Die Liste der sekundären Cluster, die aus dem primären Cluster repliziert werden.

ClusterMaintenancePolicy

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

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem die Richtlinie erstellt wurde, d.h. das Wartungsfenster oder der Ablehnungszeitraum zugewiesen 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, d.h. das Wartungsfenster oder der Ablehnungszeitraum wurde aktualisiert.

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".
weeklyMaintenanceWindow[]

object (ClusterWeeklyMaintenanceWindow)

Optional. 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_window“ eins ist.

ClusterWeeklyMaintenanceWindow

JSON-Darstellung 
{
  "day": enum (google.type.DayOfWeek),
  "startTime": {
    object (TimeOfDay)
  }
}
Felder
day

enum (google.type.DayOfWeek)

Optional. Ermöglicht die Definition eines Zeitplans, der am angegebenen Wochentag ausgeführt wird.
startTime

object (TimeOfDay)

Optional. Beginn des Zeitfensters in UTC.

TimeOfDay

JSON-Darstellung 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Felder
hours

integer

Stunden eines Tages im 24-Stunden-Format. Muss größer oder gleich 0 und in der Regel kleiner oder gleich 23 sein. Eine API kann den Wert "24:00:00" für Szenarien wie Geschäftsschlusszeit zulassen.
minutes

integer

Minuten einer Stunde. Muss größer oder gleich 0 und kleiner oder gleich 59 sein.
seconds

integer

Sekunden einer Minute. Muss größer oder gleich 0 und in der Regel kleiner oder gleich 59 sein. Eine API kann den Wert 60 zulassen, wenn sie Schaltsekunden zulässt.
nanos

integer

Sekundenbruchteile in Nanosekunden. Muss größer oder gleich 0 und kleiner oder gleich 999.999.999 sein.

ClusterMaintenanceSchedule

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

string (Timestamp format)

Nur Ausgabe. Die Startzeit einer 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".

PscServiceAttachment

JSON-Darstellung 
{
  "serviceAttachment": string,
  "connectionType": enum (ConnectionType)
}
Felder
serviceAttachment

string

Nur Ausgabe. URI des Dienstanhangs, der als Ziel für die selbst erstellte PscConnection verwendet werden soll
connectionType

enum (ConnectionType)

Nur Ausgabe. Typ einer PSC-Verbindung, die auf diesen Dienstanhang ausgerichtet ist.

ClusterEndpoint

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

object (ConnectionDetail)

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

ConnectionDetail

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 einem Cluster kann entweder während der Clustererstellung über die Dienstverbindungsautomatisierung (automatisch registrierte Verbindung) oder vom Kunden selbst (nutzerregistrierte 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 Kunden erstellt wurde, dem der Cluster gehört.

PscAutoConnection

JSON-Darstellung 
{
  "pscConnectionId": string,
  "address": 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.
address

string

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

string

Nur Ausgabe. Der URI der Weiterleitungsregel auf der Consumer-Seite. Beispiel: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}.
projectId

string

Erforderlich. Die consumer-project_id, aus der die Weiterleitungsregel erstellt wird.
network

string

Erforderlich. Das Netzwerk des Dienstnutzers, in dem sich die IP-Adresse befindet, im Format „projects/{project_id}/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. Dieser Wert wird regelmäßig aktualisiert. Verwenden Sie die Private Service Connect APIs, um den aktuellen Status abzurufen.
connectionType

enum (ConnectionType)

Nur Ausgabe. Typ der PSC-Verbindung.

AutomatedBackupConfig

JSON-Darstellung 
{
  "automatedBackupMode": enum (AutomatedBackupMode),

  // Union field schedule can be only one of the following:
  "fixedFrequencySchedule": {
    object (FixedFrequencySchedule)
  }
  // End of list of possible types for union field schedule.

  // Union field _retention can be only one of the following:
  "retention": string
  // End of list of possible types for union field _retention.
}
Felder
automatedBackupMode

enum (AutomatedBackupMode)

Optional. Der Modus für automatische Sicherungen. Wenn der Modus deaktiviert ist, werden die anderen Felder ignoriert.
Union-Feld schedule. Der Zeitplan für automatische Sicherungen. Für schedule ist nur einer der folgenden Werte zulässig:
fixedFrequencySchedule

object (FixedFrequencySchedule)

Optional. Automatische Sicherungen in einer festen Häufigkeit auslösen

Union-Feld _retention.

Für _retention ist nur einer der folgenden Werte zulässig:
retention

string (Duration format)

Optional. Wie lange automatische Sicherungen aufbewahrt werden, bevor sie gelöscht werden. Der Wert sollte zwischen 1 und 365 Tagen liegen. Wenn keine Angabe erfolgt, beträgt der Standardwert 35 Tage.

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

FixedFrequencySchedule

JSON-Darstellung 
{

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

Union-Feld _start_time.

Für _start_time ist nur einer der folgenden Werte zulässig:
startTime

object (TimeOfDay)

Erforderlich. Die Startzeit jeder automatischen Sicherung in UTC. Sie muss auf den Beginn einer Stunde festgelegt sein. Dies ist ein Pflichtfeld.

Dauer

JSON-Darstellung 
{
  "seconds": string,
  "nanos": integer
}
Felder
seconds

string (int64 format)

Signierte Sekunden des Zeitraums. Muss zwischen -315.576.000.000 und +315.576.000.000 (einschließlich) liegen. Hinweis: Diese Grenzen werden aus folgenden Werten berechnet: 60 Sek./Min. × 60 Min./Std. × 24 Std./Tag × 365,25 Tage/Jahr × 10.000 Jahre
nanos

integer

Signierte Sekundenbruchteile mit Nanosekunden-Auflösung für den Zeitraum. Dauern von weniger als einer Sekunde werden mit dem Feld „0“ seconds und einem positiven oder negativen Feld nanos dargestellt. Bei Zeiträumen von einer Sekunde oder mehr muss ein Wert ungleich null für das Feld nanos dasselbe Vorzeichen wie das Feld seconds haben. Muss zwischen -999.999.999 und +999.999.999 liegen (einschließlich).

EncryptionInfo

JSON-Darstellung 
{
  "encryptionType": enum (Type),
  "kmsKeyVersions": [
    string
  ],
  "kmsKeyPrimaryState": enum (KmsKeyState),
  "lastUpdateTime": string
}
Felder
encryptionType

enum (Type)

Nur Ausgabe. Verschlüsselungstyp.
kmsKeyVersions[]

string

Nur Ausgabe. KMS-Schlüsselversionen, die zum Schutz der ruhenden Daten verwendet werden.
kmsKeyPrimaryState

enum (KmsKeyState)

Nur Ausgabe. Der vom System wahrgenommene Status der primären Version des KMS-Schlüssels. Dieses Feld wird in Sicherungen nicht ausgefüllt.
lastUpdateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem die Verschlüsselungsinformationen zuletzt aktualisiert wurden.

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

LabelsEntry

JSON-Darstellung 
{
  "key": string,
  "value": string
}
Felder
key

string
value

string

Ausgabeschema

Diese Ressource steht für einen Vorgang mit langer Ausführungszeit, der das Ergebnis eines Netzwerk-API-Aufrufs ist.

Vorgang

JSON-Darstellung 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // Union field result can be only one of the following:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of list of possible types for union field result.
}
Felder
name

string

Der vom Server zugewiesene Name, der nur innerhalb des Dienstes eindeutig ist, der ihn ursprünglich zurückgibt. Wenn Sie die Standard-HTTP-Zuordnung verwenden, sollte name ein Ressourcenname sein, der auf operations/{unique_id} endet.
metadata

object

{

createTime: Der Zeitpunkt, zu dem der Vorgang erstellt wurde.

endTime: Der Zeitpunkt, zu dem der Vorgang abgeschlossen wurde.

target: Serverdefinierter Ressourcenpfad für das Ziel des Vorgangs.

verb: Name des vom Vorgang ausgeführten Verbs.

statusDetail: Lesbarer Status des Vorgangs, falls vorhanden.

cancelRequested: Gibt an, ob der Nutzer einen Abbruch angefordert hat. Vorgänge, die erfolgreich abgebrochen wurden, haben den Wert Operation.error mit einem google.rpc.Status.code von 1, was Code.CANCELLED entspricht.

apiVersion: Die API-Version, die zum Starten des Vorgangs verwendet wurde.

}

Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld "@type" enthält einen URI zur Identifizierung des Typs. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" }
done

boolean

Ist der Wert false, bedeutet das, dass der Vorgang noch läuft. Ist der Wert hingegen true, ist der Vorgang abgeschlossen und entweder error oder response ist verfügbar.
Union-Feld result. Das Ergebnis des Vorgangs kann entweder ein error oder eine gültige response sein. Wenn done = false ist, wird weder error noch response festgelegt. Wenn done = true ist, kann genau ein error oder eine response festgelegt werden. Einige Dienste stellen das Ergebnis möglicherweise nicht bereit. Für result ist nur einer der folgenden Werte zulässig:
error

object (Status)

Das Fehlerergebnis des Vorgangs im Fall eines Fehlers oder Abbruchs.
response

object

Die normale, erfolgreiche Antwort des Vorgangs. Wenn die ursprüngliche Methode im Erfolgsfall keine Daten zurückgibt, wie bei Delete, lautet die Antwort google.protobuf.Empty. Ist die ursprüngliche Methode standardmäßig Get/Create/Update, sollte die Antwort die Ressource sein. Bei anderen Methoden sollte die Antwort vom Typ XxxResponse sein, wobei Xxx der Name der ursprünglichen Methode ist. Wenn zum Beispiel der Name der ursprünglichen Methode TakeSnapshot() ist, ist der gefolgerte Antworttyp TakeSnapshotResponse.

Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld "@type" enthält einen URI zur Identifizierung des Typs. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" }.

Beliebig

JSON-Darstellung 
{
  "typeUrl": string,
  "value": string
}
Felder
typeUrl

string

Gibt den Typ der serialisierten Protobuf-Nachricht mit einem URI-Verweis an, der aus einem Präfix, das mit einem Schrägstrich endet, und dem vollständig qualifizierten Typnamen besteht.

Beispiel: type.googleapis.com/google.protobuf.StringValue

Dieser String muss mindestens ein /-Zeichen enthalten. Der Inhalt nach dem letzten / muss der vollständig qualifizierte Name des Typs in kanonischer Form ohne führenden Punkt sein. Schreiben Sie kein Schema für diese URI-Referenzen, damit Clients nicht versuchen, sie zu kontaktieren.

Das Präfix ist beliebig. Protobuf-Implementierungen entfernen einfach alles bis zum letzten / (einschließlich) und verwenden den Rest, um den Typ zu identifizieren. type.googleapis.com/ ist ein häufiges Standardpräfix, das für einige ältere Implementierungen erforderlich ist. Dieses Präfix gibt nicht den Ursprung des Typs an und URIs, die es enthalten, werden voraussichtlich nicht auf Anfragen reagieren.

Alle Typ-URL-Strings müssen gültige URI-Referenzen sein. Für das Textformat gilt die zusätzliche Einschränkung, dass der Inhalt der Referenz nur aus alphanumerischen Zeichen, prozentual codierten Escape-Sequenzen und Zeichen aus der folgenden Menge bestehen darf (ohne die äußeren Backticks): /-.~_!$&()*+,;=. Obwohl wir Prozentcodierungen zulassen, sollten Implementierungen sie nicht decodieren, um Verwechslungen mit vorhandenen Parsern zu vermeiden. Beispiel: type.googleapis.com%2FFoo sollte abgelehnt werden.

Im ursprünglichen Design von Any wurde die Möglichkeit in Betracht gezogen, einen Dienst zur Typauflösung unter diesen Typ-URLs zu starten. Protobuf hat jedoch nie einen solchen Dienst implementiert und betrachtet das Kontaktieren dieser URLs als problematisch und als potenzielles Sicherheitsproblem. Versuchen Sie nicht, URLs vom Typ „Kontakt“ aufzurufen.
value

string (bytes format)

Enthält eine Protobuf-Serialisierung des Typs, der durch „type_url“ beschrieben wird.

Ein base64-codierter String.

Status

JSON-Darstellung 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Felder
code

integer

Der Statuscode, der idealerweise ein ENUM-Wert von google.rpc.Code ist.
message

string

Eine an Entwickler gerichtete Fehlermeldung, die englischsprachig sein sollte. Jede für Nutzer sichtbare Fehlermeldung sollte lokalisiert und im Feld google.rpc.Status.details gesendet werden. Sie kann auch clientseitig lokalisiert werden.
details[]

object

Eine Auflistung aller Meldungen, die die Fehlerdetails enthalten. Es gibt einen gemeinsamen Satz von Nachrichtentypen, die APIs verwenden können.

Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld "@type" enthält einen URI zur Identifizierung des Typs. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" }.

Tool-Annotationen

Destruktiver Hinweis: ❌ | Idempotenter Hinweis: ❌ | Hinweis „Nur lesen“: ❌ | Hinweis „Offene Welt“: ❌