MCP Tools Reference: memorystore.googleapis.com

工具：update_instance

更新 Memorystore for Valkey 实例。

以下示例演示了如何使用 curl 调用 update_instance MCP 工具。

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

输入架构

UpdateInstance 的请求消息。

UpdateInstanceRequest

JSON 表示法 
{
  "updateMask": string,
  "instance": {
    object (Instance)
  },
  "requestId": string
}
字段
updateMask

string (FieldMask format)

可选。要在实例中更新的字段的列表。必须至少指定一个字段。

这是完全限定字段名称的逗号分隔列表。示例："user.displayName,photo"。
instance

object (Instance)

必需。要更新的实例。
requestId

string

可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID，这样，在您必须重试请求时，服务器就会知道忽略该请求（如果该请求已完成）。服务器将保证在第一次完成该请求后的至少 60 分钟内避免重复处理该请求。

例如，假设在您最初发出一个请求后，该请求超时，然后您使用相同的请求 ID 再次发出该请求，那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了，服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。

请求 ID 必须是有效的 UUID，且不支持全部由零组成的 UUID（即 00000000-0000-0000-0000-000000000000）。

FieldMask

JSON 表示法 
{
  "paths": [
    string
  ]
}
字段
paths[]

string

一组字段掩码路径。

实例

JSON 表示法 
{
  "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)
    }
  ],
  "pscAttachmentDetails": [
    {
      object (PscAttachmentDetail)
    }
  ],
  "endpoints": [
    {
      object (InstanceEndpoint)
    }
  ],
  "mode": enum (Mode),
  "maintenancePolicy": {
    object (MaintenancePolicy)
  },
  "maintenanceSchedule": {
    object (MaintenanceSchedule)
  },
  "crossInstanceReplicationConfig": {
    object (CrossInstanceReplicationConfig)
  },
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "automatedBackupConfig": {
    object (AutomatedBackupConfig)
  },
  "availableMaintenanceVersions": [
    string
  ],
  "allowFewerZonesDeployment": boolean,
  "migrationConfig": {
    object (MigrationConfig)
  },

  // 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 _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 _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 _ondemand_maintenance can be only one of the following:
  "ondemandMaintenance": boolean
  // End of list of possible types for union field _ondemand_maintenance.

  // 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 _async_instance_endpoints_deletion_enabled can be only one of
  // the following:
  "asyncInstanceEndpointsDeletionEnabled": boolean
  // End of list of possible types for union field
  // _async_instance_endpoints_deletion_enabled.

  // 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 _backup_collection can be only one of the following:
  "backupCollection": string
  // End of list of possible types for union field _backup_collection.

  // 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 can be only one of the following:
  "aclPolicy": string
  // End of list of possible types for union field _acl_policy.

  // 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.
}
字段
name

string

标识符。实例的唯一名称。格式：projects/{project}/locations/{location}/instances/{instance}
createTime

string (Timestamp format)

仅限输出。实例的创建时间戳。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

仅限输出。实例的最新更新时间戳。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
labels

map (key: string, value: string)

可选。用于表示用户提供的元数据的标签。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
state

enum (State)

仅限输出。实例的当前状态。
stateInfo

object (StateInfo)

仅限输出。有关实例状态的其他信息。
uid

string

仅限输出。系统为实例分配的唯一标识符。
authorizationMode

enum (AuthorizationMode)

可选。不可变。实例的授权模式。
transitEncryptionMode

enum (TransitEncryptionMode)

可选。不可变。实例的传输加密模式。
shardCount

integer

可选。实例的分片数。
discoveryEndpoints[]
(deprecated)

object (DiscoveryEndpoint)

仅限输出。已弃用：discovery_endpoints 参数已弃用。因此，如果使用端点参数创建连接，则不会填充此字段。对于发现，请使用 connectionType 为 CONNECTION_TYPE_DISCOVERY 的 endpoints.connections.pscConnection 和 endpoints.connections.pscAutoConnection，而不是此参数。
nodeType

enum (NodeType)

可选。实例中各个节点的机器类型。
persistenceConfig

object (PersistenceConfig)

可选。实例的持久性配置。
engineVersion

string

可选。实例的引擎版本。
engineConfigs

map (key: string, value: string)

可选。用户为实例提供的引擎配置。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
nodeConfig

object (NodeConfig)

仅限输出。实例的各个节点的配置。
zoneDistributionConfig

object (ZoneDistributionConfig)

可选。不可变。实例的可用区分布配置，用于节点分配。
pscAutoConnections[]
(deprecated)

object (PscAutoConnection)

可选。不可变。已弃用：请改用 endpoints.connections.psc_auto_connection 值。
pscAttachmentDetails[]

object (PscAttachmentDetail)

仅限输出。用于配置 PSC 连接的服务连接详情。
endpoints[]

object (InstanceEndpoint)

可选。实例的端点。
mode

enum (Mode)

可选。实例的模式配置。
maintenancePolicy

object (MaintenancePolicy)

可选。实例的维护政策。如果未提供，系统将根据 Memorystore 内部发布时间表执行维护事件。
maintenanceSchedule

object (MaintenanceSchedule)

仅限输出。已发布的维护时间表。
crossInstanceReplicationConfig

object (CrossInstanceReplicationConfig)

可选。跨实例复制的配置。
encryptionInfo

object (EncryptionInfo)

仅限输出。集群静态数据的加密信息。
automatedBackupConfig

object (AutomatedBackupConfig)

可选。实例的自动备份配置。
availableMaintenanceVersions[]

string

仅限输出。此字段用于确定自助更新可用的维护版本。
allowFewerZonesDeployment
(deprecated)

boolean

可选。不可变。已弃用，请勿使用。
migrationConfig

object (MigrationConfig)

仅限输出。实例的迁移配置。
联合字段 import_sources。要从中导入的来源。import_sources 只能是下列其中一项：
gcsSource

object (GcsBackupSource)

可选。不可变。存储在 Cloud Storage 存储分区中的备份。Cloud Storage 存储分区需要与实例位于同一区域。需要读取权限才能从提供的 Cloud Storage 对象导入数据。
managedBackupSource

object (ManagedBackupSource)

可选。不可变。由 Memorystore 服务生成和管理的备份。

联合字段 _replica_count。

_replica_count 只能是下列其中一项：
replicaCount

integer

可选。每个分片的副本节点数。如果省略，则默认为 0 个副本。

联合字段 _deletion_protection_enabled。

_deletion_protection_enabled 只能是下列其中一项：
deletionProtectionEnabled

boolean

可选。如果设置为 true，则删除实例的操作会失败。

联合字段 _simulate_maintenance_event。

_simulate_maintenance_event 只能是下列其中一项：
simulateMaintenanceEvent

boolean

可选。仅限输入。模拟维护事件。

联合字段 _ondemand_maintenance。

_ondemand_maintenance 只能是下列其中一项：
ondemandMaintenance
(deprecated)

boolean

可选。仅限输入。实例的按需维护。

联合字段 _satisfies_pzs。

_satisfies_pzs 只能是下列其中一项：
satisfiesPzs

boolean

可选。仅限输出。留待将来使用。

联合字段 _satisfies_pzi。

_satisfies_pzi 只能是下列其中一项：
satisfiesPzi

boolean

可选。仅限输出。留待将来使用。

联合字段 _async_instance_endpoints_deletion_enabled。

_async_instance_endpoints_deletion_enabled 只能是下列其中一项：
asyncInstanceEndpointsDeletionEnabled

boolean

可选。如果为 true，则可以异步删除由客户创建和注册的实例端点。也就是说，可以在删除实例端点中的转发规则之前取消注册此类实例端点。

联合字段 _kms_key。

_kms_key 只能是下列其中一项：
kmsKey

string

可选。用于加密集群静态数据的 KMS 密钥。

联合字段 _backup_collection。

_backup_collection 只能是下列其中一项：
backupCollection

string

仅限输出。备份集合的完整资源名称。示例：projects/{project}/locations/{location}/backupCollections/{collection}

联合字段 _maintenance_version。

_maintenance_version 只能是下列其中一项：
maintenanceVersion

string

可选。此字段可用于触发自助更新，以指示所需的维护版本。此字段的输入可由 available_maintenance_versions 字段确定。

联合字段 _effective_maintenance_version。

_effective_maintenance_version 只能是下列其中一项：
effectiveMaintenanceVersion

string

仅限输出。此字段表示实例的实际维护版本。

联合字段 _server_ca_mode。

_server_ca_mode 只能是下列其中一项：
serverCaMode

enum (ServerCaMode)

可选。不可变。实例的服务器 CA 模式。

联合字段 _server_ca_pool。

_server_ca_pool 只能是下列其中一项：
serverCaPool

string

可选。不可变。实例的客户管理的 CA 池。仅在服务器 CA 模式为 CUSTOMER_MANAGED_CAS_CA 时适用。格式：“projects/{project}/locations/区域/caPools/{ca_pool}”。

联合字段 _rotate_server_certificate。

_rotate_server_certificate 只能是下列其中一项：
rotateServerCertificate

boolean

可选。仅限输入。轮替服务器证书。

联合字段 _acl_policy。

_acl_policy 只能是下列其中一项：
aclPolicy

string

可选。实例的 ACL 政策。格式：projects/{project}/locations/{location}/aclPolicies/{acl_policy}

联合字段 _acl_policy_in_sync。

_acl_policy_in_sync 只能是下列其中一项：
aclPolicyInSync

boolean

仅限输出。应用于实例的 ACL 规则是否与最新的 ACL 政策规则同步。仅当为实例设置了 ACL 政策时，此字段才适用。

GcsBackupSource

JSON 表示法 
{
  "uris": [
    string
  ]
}
字段
uris[]

string

可选。示例：gs://bucket1/object1、gs://bucket2/folder2/object2

ManagedBackupSource

JSON 表示法 
{
  "backup": string
}
字段
backup

string

可选。示例：//memorystore.googleapis.com/projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup} 系统还支持较短版本的备份名称（不带前缀），例如 projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup_id} 在这种情况下，系统会假定备份位于 memorystore.googleapis.com 下。

时间戳

JSON 表示法 
{
  "seconds": string,
  "nanos": integer
}
字段
seconds

string (int64 format)

表示世界协调时间 (UTC) 的秒数（从 Unix 纪元 1970-01-01T00:00:00Z 开始算起）。必须介于 -62135596800 到 253402300799 之间（含边界值），对应于 0001-01-01T00:00:00Z 到 9999-12-31T23:59:59Z。
nanos

integer

秒数的非负小数部分（以纳秒为单位）。此字段是时长的纳秒部分，而不是秒的替代项。对于含小数部分的负秒数，仍必须包含按时间递升的非负纳秒值。必须在 0 到 999,999,999 之间（含边界值）。

LabelsEntry

JSON 表示法 
{
  "key": string,
  "value": string
}
字段
key

string
value

string

StateInfo

JSON 表示法 
{

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

联合字段 info。

info 只能是下列其中一项：
updateInfo

object (UpdateInfo)

仅限输出。当实例状态为 UPDATING 时，描述正在进行的更新。

UpdateInfo

JSON 表示法 
{

  // 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_engine_version can be only one of the following:
  "targetEngineVersion": string
  // End of list of possible types for union field _target_engine_version.

  // 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.
}
字段

联合字段 _target_shard_count。

_target_shard_count 只能是下列其中一项：
targetShardCount

integer

仅限输出。实例的目标分片数。

联合字段 _target_replica_count。

_target_replica_count 只能是下列其中一项：
targetReplicaCount

integer

仅限输出。相应实例的每个分片的目标副本节点数。

联合字段 _target_engine_version。

_target_engine_version 只能是下列其中一项：
targetEngineVersion

string

仅限输出。实例的目标引擎版本。

联合字段 _target_node_type。

_target_node_type 只能是下列其中一项：
targetNodeType

enum (NodeType)

仅限输出。实例的目标节点类型。

DiscoveryEndpoint

JSON 表示法 
{
  "address": string,
  "port": integer,
  "network": string
}
字段
address

string

仅限输出。公开端点的 IP 地址，客户端会连接到该端点。
port

integer

仅限输出。公开端点的端口号。
network

string

仅限输出。将预留发现端点 IP 地址的网络，格式为 projects/{network_project}/global/networks/{network_id}。

PersistenceConfig

JSON 表示法 
{
  "mode": enum (PersistenceMode),
  "rdbConfig": {
    object (RDBConfig)
  },
  "aofConfig": {
    object (AOFConfig)
  }
}
字段
mode

enum (PersistenceMode)

可选。当前持久模式。
rdbConfig

object (RDBConfig)

可选。RDB 配置。如果模式不是 RDB，系统会忽略此字段。
aofConfig

object (AOFConfig)

可选。AOF 配置。如果模式不是 AOF，系统会忽略此字段。

RDBConfig

JSON 表示法 
{
  "rdbSnapshotPeriod": enum (SnapshotPeriod),
  "rdbSnapshotStartTime": string
}
字段
rdbSnapshotPeriod

enum (SnapshotPeriod)

可选。RDB 快照之间的间隔时长。
rdbSnapshotStartTime

string (Timestamp format)

可选。首次尝试拍摄快照的时间，以及未来快照将对齐的时间。如果未提供，则使用当前时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

AOFConfig

JSON 表示法 
{
  "appendFsync": enum (AppendFsync)
}
字段
appendFsync

enum (AppendFsync)

可选。fsync 模式。

EngineConfigsEntry

JSON 表示法 
{
  "key": string,
  "value": string
}
字段
key

string
value

string

NodeConfig

JSON 表示法 
{
  "sizeGb": number
}
字段
sizeGb

number

仅限输出。节点的内存大小（以 GB 为单位）。

ZoneDistributionConfig

JSON 表示法 
{
  "zone": string,
  "mode": enum (ZoneDistributionMode)
}
字段
zone

string

可选。定义了在 SINGLE_ZONE 模式下分配所有资源的可用区。在 MULTI_ZONE 模式下会被忽略。
mode

enum (ZoneDistributionMode)

可选。当前区域分配模式。默认值为 MULTI_ZONE。

PscAutoConnection

JSON 表示法 
{
  "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.
}
字段
pscConnectionId

string

仅限输出。连接到服务连接的转发规则的 PSC 连接 ID。
ipAddress

string

仅限输出。为 PSC 转发规则分配的使用方网络中的 IP。
forwardingRule

string

仅限输出。使用方转发规则的 URI。格式：projects/{project}/区域/区域/forwardingRules/{forwarding_rule}
projectId

string

必需。建立 PSC 连接的使用方 project_id。这应与创建实例时所用的 project_id 相同。
network

string

必需。创建 PSC 端点的网络，格式为 projects/{project_id}/global/networks/{network_id}。
serviceAttachment

string

仅限输出。作为 PSC 连接的目标的服务连接，采用 projects/{project-id}/区域/区域/serviceAttachments/{service-attachment-id} 格式。
pscConnectionStatus

enum (PscConnectionStatus)

仅限输出。PSC 连接的状态：是否存在有效连接，或者连接是否已不再存在。请注意，此值会定期更新。请使用 Private Service Connect API 获取最新状态。
connectionType

enum (ConnectionType)

仅限输出。PSC 连接的类型。
联合字段 ports。公开端点的端口。ports 只能是下列其中一项：
port

integer

可选。仅针对主/读取器或发现端点设置端口。

PscAttachmentDetail

JSON 表示法 
{
  "serviceAttachment": string,
  "connectionType": enum (ConnectionType)
}
字段
serviceAttachment

string

仅限输出。您自行创建的 PscConnection 应使用的服务连接 URI 作为目标。
connectionType

enum (ConnectionType)

仅限输出。PSC 端点的类型。

InstanceEndpoint

JSON 表示法 
{
  "connections": [
    {
      object (ConnectionDetail)
    }
  ]
}
字段
connections[]

object (ConnectionDetail)

可选。一组 PSC 连接。它们是在同一 VPC 网络中创建的，集群中的每个服务连接对应一个。

ConnectionDetail

JSON 表示法 
{

  // 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.
}
字段
联合字段 connection。与实例的 PSC 连接可以在集群创建期间通过服务连接自动化（自动连接）创建，也可以由客户自行创建（用户创建的连接）。connection 只能是下列其中一项：
pscAutoConnection

object (PscAutoConnection)

不可变。通过服务连接自动化功能创建的 PSC 连接的详细信息。
pscConnection

object (PscConnection)

用户创建的 PSC 连接的详细信息。

PscConnection

JSON 表示法 
{
  "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.
}
字段
pscConnectionId

string

必需。连接到服务连接的转发规则的 PSC 连接 ID。
ipAddress

string

必需。为 PSC 转发规则分配的使用方网络中的 IP。
forwardingRule

string

必需。使用方转发规则的 URI。格式：projects/{project}/区域/区域/forwardingRules/{forwarding_rule}
projectId

string

仅限输出。创建转发规则的使用方项目 ID。
network

string

必需。IP 地址所在的消费方网络，格式为 projects/{project_id}/global/networks/{network_id}。
serviceAttachment

string

必需。作为 PSC 连接的目标的服务连接，采用 projects/{project-id}/区域/区域/serviceAttachments/{service-attachment-id} 格式。
pscConnectionStatus

enum (PscConnectionStatus)

仅限输出。PSC 连接的状态：是否存在有效连接，或者连接是否已不再存在。请注意，此值会定期更新。请使用 Private Service Connect API 获取最新状态。
connectionType

enum (ConnectionType)

仅限输出。PSC 连接的类型。
联合字段 ports。公开端点的端口。ports 只能是下列其中一项：
port

integer

可选。仅针对主/读取器或发现端点设置端口。

MaintenancePolicy

JSON 表示法 
{
  "createTime": string,
  "updateTime": string,
  "weeklyMaintenanceWindow": [
    {
      object (WeeklyMaintenanceWindow)
    }
  ]
}
字段
createTime

string (Timestamp format)

仅限输出。政策的创建时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

仅限输出。政策的更新时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
weeklyMaintenanceWindow[]

object (WeeklyMaintenanceWindow)

可选。应用于相应政策所涵盖资源的维护窗口。最小值为 1。对于当前版本，weekly_window 的最大数量应为 1。

WeeklyMaintenanceWindow

JSON 表示法 
{
  "day": enum (google.type.DayOfWeek),
  "startTime": {
    object (TimeOfDay)
  }
}
字段
day

enum (google.type.DayOfWeek)

可选。允许定义在每周指定日期运行的时间表。
startTime

object (TimeOfDay)

可选。时间段的开始时间（以世界协调时间 [UTC] 表示）。

TimeOfDay

JSON 表示法 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
字段
hours

integer

一天中的小时（采用 24 小时制）。必须大于或等于 0，且通常必须小于或等于 23。对于业务结束时间等场景，API 可以选择允许“24:00:00”一值。
minutes

integer

一小时中的分钟数。必须大于或等于 0，且小于或等于 59。
seconds

integer

一分钟中的秒数。必须大于或等于 0，通常必须小于或等于 59。如果 API 允许闰秒，则 API 可以允许 60 一值。
nanos

integer

秒数的小数部分（以纳秒为单位）。必须大于或等于 0，且小于或等于 999,999,999。

MaintenanceSchedule

JSON 表示法 
{
  "startTime": string,
  "endTime": string
}
字段
startTime

string (Timestamp format)

仅限输出。此实例的任何近期维护的开始时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
endTime

string (Timestamp format)

仅限输出。此实例的任何近期维护的结束时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

CrossInstanceReplicationConfig

JSON 表示法 
{
  "instanceRole": enum (InstanceRole),
  "primaryInstance": {
    object (RemoteInstance)
  },
  "secondaryInstances": [
    {
      object (RemoteInstance)
    }
  ],
  "updateTime": string,
  "membership": {
    object (Membership)
  }
}
字段
instanceRole

enum (InstanceRole)

必需。实例在跨实例复制中的角色。
primaryInstance

object (RemoteInstance)

可选。用作相应次要实例的复制源的主实例的详细信息。

此字段仅针对辅助实例设置。
secondaryInstances[]

object (RemoteInstance)

可选。正在从此主实例复制数据的次要实例的列表。

此字段仅针对主实例设置。
updateTime

string (Timestamp format)

仅限输出。上次更新跨实例复制配置的时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
membership

object (Membership)

仅限输出。参与跨实例复制的所有成员实例的只输出视图。每个成员实例（无论其实例角色是主实例还是次要实例）都会提供此视图。

主实例可以提供有关所有从其复制数据的次要实例的信息。不过，次要实例只知道它正在复制的主实例。不过，在主实例不可用的情况下（例如区域性服务中断），可以向任何其他成员实例发送 Getinstance 请求，并且此字段将列出参与跨实例复制的所有成员实例。

RemoteInstance

JSON 表示法 
{
  "instance": string,
  "uid": string
}
字段
instance

string

可选。远程实例的完整资源路径，格式为：projects//locations//instances/
uid

string

仅限输出。远程实例的唯一标识符。

成员

JSON 表示法 
{
  "primaryInstance": {
    object (RemoteInstance)
  },
  "secondaryInstances": [
    {
      object (RemoteInstance)
    }
  ]
}
字段
primaryInstance

object (RemoteInstance)

仅限输出。充当次要实例复制来源的主实例。
secondaryInstances[]

object (RemoteInstance)

仅限输出。从主实例复制数据的次要实例的列表。

EncryptionInfo

JSON 表示法 
{
  "encryptionType": enum (Type),
  "kmsKeyVersions": [
    string
  ],
  "kmsKeyPrimaryState": enum (KmsKeyState),
  "lastUpdateTime": string
}
字段
encryptionType

enum (Type)

仅限输出。加密类型。
kmsKeyVersions[]

string

仅限输出。用于保护静态数据的 KMS 密钥版本。
kmsKeyPrimaryState

enum (KmsKeyState)

仅限输出。系统感知到的 KMS 密钥主要版本状态。此字段不会填充在备份中。
lastUpdateTime

string (Timestamp format)

仅限输出。加密信息最近一次更新的时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

AutomatedBackupConfig

JSON 表示法 
{
  "automatedBackupMode": enum (AutomatedBackupMode),
  "retention": string,

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

enum (AutomatedBackupMode)

可选。自动备份模式。如果该模式处于停用状态，系统会忽略其他字段。
retention

string (Duration format)

可选。自动备份在被删除之前的保留时长。该值应介于 1 天到 365 天之间。如果未指定，则默认值为 35 天。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
联合字段 schedule。自动备份的时间表。schedule 只能是下列其中一项：
fixedFrequencySchedule

object (FixedFrequencySchedule)

可选。以固定频率触发自动备份。

FixedFrequencySchedule

JSON 表示法 
{
  "startTime": {
    object (TimeOfDay)
  }
}
字段
startTime

object (TimeOfDay)

必需。每次自动备份的开始时间（以世界协调时间 [UTC] 表示）。必须设置为某个小时的开始时间。此字段是必填字段。

时长

JSON 表示法 
{
  "seconds": string,
  "nanos": integer
}
字段
seconds

string (int64 format)

时间段的带符号秒数。必须介于 -315,576,000,000 到 +315,576,000,000 之间（含边界值）。注意：这些界限的计算依据是：60 秒/分钟 * 60 分钟/小时 * 24 小时/天 * 365.25 天/年 * 10000 年
nanos

integer

时间跨度的有符号秒数小数部分（以纳秒为单位）。小于 1 秒的时长用 0 seconds 字段和正或负 nanos 字段表示。对于时长为 1 秒或更长时间的情况，nanos 字段的非零值必须与 seconds 字段的符号相同。必须介于 -999,999,999 到 +999,999,999 之间（含边界值）。

MigrationConfig

JSON 表示法 
{
  "state": enum (State),
  "forceFinishMigration": boolean,

  // Union field source can be only one of the following:
  "selfManagedSource": {
    object (SelfManagedSource)
  }
  // End of list of possible types for union field source.
}
字段
state

enum (State)

仅限输出。实例的迁移状态。
forceFinishMigration

boolean

仅限输出。表示一个布尔值标志，用于在停止复制之前强制完成迁移，而无需在源和目标之间进行偏移量追赶验证。
联合字段 source。有关迁移来源的详细信息。source 只能是下列其中一项：
selfManagedSource

object (SelfManagedSource)

仅限输出。从自行管理的 Valkey/Redis 实例迁移的配置

SelfManagedSource

JSON 表示法 
{
  "ipAddress": string,
  "port": integer,
  "networkAttachment": string
}
字段
ipAddress

string

必需。来源实例的 IP 地址。此 IP 地址应为稳定 IP 地址，在整个迁移过程中，Memorystore 实例都可以访问该地址。
port

integer

必需。源实例的端口。此端口应是一个稳定的端口，在整个迁移过程中，Memorystore 实例都可以访问该端口。
networkAttachment

string

必需。用于建立与源实例的连接的 Private Service Connect 网络连接的资源名称。此网络附件具有以下要求：1. 必须与 Memorystore 实例位于同一项目中。2. 它必须与 Memorystore 实例位于同一区域。3. 连接到网络连接的子网必须与源实例节点位于同一 VPC 网络中。

格式：projects/{project}/区域/区域/networkAttachments/{network_attachment}

输出架构

此资源表示由网络 API 调用引发的长时间运行的操作。

操作

JSON 表示法 
{
  "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.
}
字段
name

string

由服务器分配的名称，该名称仅在最初返回它的那项服务中是唯一的。如果您使用默认 HTTP 映射，则 name 应是以 operations/{unique_id} 结尾的资源名称。
metadata

object

与操作关联的服务专属元数据。它通常包含进度信息和常见元数据（如创建时间）。一些服务可能不会提供此类元数据。任何返回长时间运行操作的方法都应记录元数据类型（如果有的话）。

此对象可以包含任意类型的字段。附加字段 "@type" 包含用于标示相应类型的 URI。示例：{ "id": 1234, "@type": "types.example.com/standard/id" }。
done

boolean

如果值为 false，则表示操作仍在进行中。如果为 true，则表示操作已完成，其结果不是 error 就是 response。
联合字段 result。操作结果，可以是 error，也可以是有效的 response。如果 done == false，则既不会设置 error，也不会设置 response。如果 done == true，则只能设置 error 或 response 中的一项。部分服务可能不会提供结果。result 只能是下列其中一项：
error

object (Status)

操作失败或被取消时表示有错误发生的结果。
response

object

操作的常规成功响应。如果原始方法在成功时不返回任何数据（如 Delete），则响应为 google.protobuf.Empty。如果原始方法为标准 Get/Create/Update 方法，则响应应该为资源。对于其他方法，响应类型应为 XxxResponse，其中 Xxx 是原始方法的名称。例如，如果原始方法名称为 TakeSnapshot()，则推断的响应类型为 TakeSnapshotResponse。

此对象可以包含任意类型的字段。附加字段 "@type" 包含用于标示相应类型的 URI。示例：{ "id": 1234, "@type": "types.example.com/standard/id" }。

不限

JSON 表示法 
{
  "typeUrl": string,
  "value": string
}
字段
typeUrl

string

通过 URI 引用（包含以斜杠结尾的前缀和完全限定的类型名称）来标识序列化 Protobuf 消息的类型。

示例：type.googleapis.com/google.protobuf.StringValue

此字符串必须包含至少一个 / 字符，并且最后一个 / 之后的内容必须是规范形式的完全限定名，不含前导点。请勿在这些 URI 引用中写入方案，以免客户端尝试联系它们。

前缀是任意的，Protobuf 实现应仅剥离最后一个 / 之前（包括最后一个 /）的所有内容，以标识类型。type.googleapis.com/ 是某些旧版实现所需的常见默认前缀。此前缀并不表示类型的来源，包含该前缀的 URI 不应响应任何请求。

所有类型网址字符串都必须是合法的 URI 引用，并且（对于文本格式）还必须满足以下额外限制：引用的内容只能包含字母数字字符、百分号编码的转义字符以及以下集合中的字符（不包括外侧的反引号）：/-.~_!$&()*+,;=。尽管我们允许使用百分比编码，但实现不应将其转义，以免与现有解析器混淆。例如，应拒绝 type.googleapis.com%2FFoo。

在 Any 的原始设计中，曾考虑过在这些类型网址上启动类型解析服务的可能性，但 Protobuf 从未实现过此类服务，并且认为联系这些网址存在问题，可能会导致安全问题。不尝试联系人类型网址。
value

string (bytes format)

包含由 type_url 描述的类型的 Protobuf 序列化。

使用 base64 编码的字符串。

状态

JSON 表示法 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
字段
code

integer

状态代码，应为 google.rpc.Code 的枚举值。
message

string

面向开发者的错误消息（应采用英语）。任何向用户显示的错误消息都应进行本地化并通过 google.rpc.Status.details 字段发送，或者由客户端进行本地化。
details[]

object

包含错误详细信息的消息列表。有一组通用的消息类型可供 API 使用。

可以包含任意类型字段的对象。附加字段 "@type" 包含用于标示相应类型的 URI。示例：{ "id": 1234, "@type": "types.example.com/standard/id" }。

工具注释

破坏性提示：❌ | 等幂性提示：❌ | 只读提示：❌ | 开放世界提示：❌