- 资源:实例
- GcsBackupSource
- ManagedBackupSource
- 状态
- StateInfo
- UpdateInfo
- AuthorizationMode
- TransitEncryptionMode
- DiscoveryEndpoint
- PersistenceConfig
- PersistenceMode
- RDBConfig
- SnapshotPeriod
- AOFConfig
- AppendFsync
- NodeConfig
- ZoneDistributionConfig
- ZoneDistributionMode
- PscAutoConnection
- PscConnectionStatus
- ConnectionType
- PscAttachmentDetail
- InstanceEndpoint
- ConnectionDetail
- PscConnection
- Mode
- MaintenancePolicy
- WeeklyMaintenanceWindow
- MaintenanceSchedule
- CrossInstanceReplicationConfig
- InstanceRole
- RemoteInstance
- 会员
- AutomatedBackupConfig
- FixedFrequencySchedule
- AutomatedBackupMode
- 方法
资源:实例
Memorystore 实例。
JSON 表示法 |
---|
{ "name": string, "createTime": string, "updateTime": string, "labels": { string: string, ... }, "state": enum ( |
字段 | |
---|---|
name |
标识符。实例的唯一名称。格式:projects/{project}/locations/{location}/instances/{instance} |
createTime |
仅限输出。实例的创建时间戳。 采用 RFC 3339 标准,生成的输出将始终在末尾带 Z,并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
updateTime |
仅限输出。实例的最新更新时间戳。 采用 RFC 3339 标准,生成的输出将始终在末尾带 Z,并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
labels |
可选。用于表示用户提供的元数据的标签。 包含一系列 |
state |
仅限输出。实例的当前状态。 |
stateInfo |
仅限输出。有关实例状态的其他信息。 |
uid |
仅限输出。系统为实例分配的唯一标识符。 |
authorizationMode |
可选。不可变。实例的授权模式。 |
transitEncryptionMode |
可选。不可变。实例的传输加密模式。 |
shardCount |
可选。实例的分片数。 |
discoveryEndpoints[] |
仅限输出。已弃用:请改用 endpoints.connections.psc_auto_connection 或 endpoints.connections.psc_connection 值。 |
nodeType |
可选。实例中各个节点的机器类型。 |
persistenceConfig |
可选。实例的持久性配置。 |
engineVersion |
可选。实例的引擎版本。 |
engineConfigs |
可选。实例的用户提供的引擎配置。 包含一系列 |
nodeConfig |
仅限输出。实例的各个节点的配置。 |
zoneDistributionConfig |
可选。不可变。实例的可用区分布配置,用于节点分配。 |
pscAutoConnections[] |
可选。不可变。已弃用:请改用 endpoints.connections.psc_auto_connection 值。 |
pscAttachmentDetails[] |
仅限输出。用于配置 PSC 连接的服务连接详情。 |
endpoints[] |
可选。实例的端点。 |
mode |
可选。实例的模式配置。 |
maintenancePolicy |
可选。实例的维护政策。如果未提供,系统将根据 Memorystore 内部发布时间表执行维护事件。 |
maintenanceSchedule |
仅限输出。已发布的维护时间表。 |
crossInstanceReplicationConfig |
可选。跨实例复制的配置。 |
encryptionInfo |
仅限输出。集群静态数据的加密信息。 |
automatedBackupConfig |
可选。实例的自动备份配置。 |
allowFewerZonesDeployment |
可选。不可变。允许客户指定是否可以接受在少于 3 个可用区中部署多可用区实例。设置后,如果在创建实例期间发生可用区级服务中断,实例将仅部署在 2 个可用区中,并在其生命周期内保持在这 2 个可用区中。 |
联合字段 import_sources 。要导入的来源。import_sources 只能是下列其中一项: |
|
gcsSource |
可选。不可变。存储在 Cloud Storage 存储分区中的备份。Cloud Storage 存储分区需要与实例位于同一区域。需要读取权限才能从提供的 Cloud Storage 对象导入数据。 |
managedBackupSource |
可选。不可变。由 Memorystore 服务生成和管理的备份。 |
replicaCount |
可选。每个分片的副本节点数。如果省略,则默认为 0 个副本。 |
deletionProtectionEnabled |
可选。如果设置为 true,则删除实例的操作会失败。 |
simulateMaintenanceEvent |
可选。仅限输入。模拟维护事件。 |
ondemandMaintenance |
可选。仅限输入。实例的按需维护。 |
asyncInstanceEndpointsDeletionEnabled |
可选。如果为 true,则客户创建和注册的实例端点可以异步删除。也就是说,可以在删除实例端点中的转发规则之前取消注册此类实例端点。 |
kmsKey |
可选。用于加密集群静态数据的 KMS 密钥。 |
backupCollection |
仅限输出。备份集合的完整资源名称。示例:projects/{project}/locations/{location}/backupCollections/{collection} |
GcsBackupSource
存储在 Cloud Storage 存储分区中的备份。Cloud Storage 存储分区需要与实例位于同一区域。
JSON 表示法 |
---|
{ "uris": [ string ] } |
字段 | |
---|---|
uris[] |
可选。示例:gs://bucket1/object1、gs://bucket2/folder2/object2 |
ManagedBackupSource
由 Memorystore 生成和管理的备份。
JSON 表示法 |
---|
{ "backup": string } |
字段 | |
---|---|
backup |
可选。示例://memorystore.googleapis.com/projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup} 系统还支持较短版本的备份名称(不带前缀),例如 projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backupId} 在这种情况下,系统会假定备份位于 memorystore.googleapis.com 下。 |
州
实例的可能状态。
枚举 | |
---|---|
STATE_UNSPECIFIED |
未设置。 |
CREATING |
正在创建实例。 |
ACTIVE |
实例已创建并可供使用。 |
UPDATING |
正在更新实例。 |
DELETING |
正在删除实例。 |
StateInfo
有关实例状态的其他信息。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段
|
|
updateInfo |
仅限输出。当实例状态为 UPDATING 时,描述正在进行的更新。 |
UpdateInfo
表示状态为 UPDATING 的实例的相关信息。
JSON 表示法 |
---|
{
"targetShardCount": integer,
"targetReplicaCount": integer,
"targetEngineVersion": string,
"targetNodeType": enum ( |
字段 | |
---|---|
targetShardCount |
仅限输出。实例的目标分片数。 |
targetReplicaCount |
仅限输出。相应实例的每个分片的目标副本节点数。 |
targetEngineVersion |
仅限输出。实例的目标引擎版本。 |
targetNodeType |
仅限输出。实例的目标节点类型。 |
AuthorizationMode
实例的可能授权模式。
枚举 | |
---|---|
AUTHORIZATION_MODE_UNSPECIFIED |
未设置。 |
AUTH_DISABLED |
授权已停用。 |
IAM_AUTH |
IAM 基本授权。 |
TransitEncryptionMode
实例可能采用的传输加密模式。
枚举 | |
---|---|
TRANSIT_ENCRYPTION_MODE_UNSPECIFIED |
未设置。 |
TRANSIT_ENCRYPTION_DISABLED |
传输加密已停用。 |
SERVER_AUTHENTICATION |
服务器管理的加密用于传输加密。 |
DiscoveryEndpoint
表示客户端连接到实例的端点。
JSON 表示法 |
---|
{ "address": string, "port": integer, "network": string } |
字段 | |
---|---|
address |
仅限输出。公开端点的 IP 地址,客户端会连接到该端点。 |
port |
仅限输出。公开端点的端口号。 |
network |
仅限输出。将预留发现端点 IP 地址的网络,格式为 projects/{networkProject}/global/networks/{network_id}。 |
PersistenceConfig
表示实例的持久性配置。
JSON 表示法 |
---|
{ "mode": enum ( |
字段 | |
---|---|
mode |
可选。当前持久模式。 |
rdbConfig |
可选。RDB 配置。如果模式不是 RDB,系统会忽略此字段。 |
aofConfig |
可选。AOF 配置。如果模式不是 AOF,系统会忽略此字段。 |
PersistenceMode
可能的持久模式。
枚举 | |
---|---|
PERSISTENCE_MODE_UNSPECIFIED |
未设置。 |
DISABLED |
持久性已停用,所有快照数据均已删除。 |
RDB |
已启用基于 RDB 的持久化。 |
AOF |
已启用基于 AOF 的持久性。 |
RDBConfig
基于 RDB 的持久化功能的配置。
JSON 表示法 |
---|
{
"rdbSnapshotPeriod": enum ( |
字段 | |
---|---|
rdbSnapshotPeriod |
可选。RDB 快照之间的间隔时长。 |
rdbSnapshotStartTime |
可选。首次尝试拍摄快照的时间,以及未来快照将对齐的时间。如果未提供,则使用当前时间。 采用 RFC 3339 标准,生成的输出将始终在末尾带 Z,并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
SnapshotPeriod
可能的快照时间段。
枚举 | |
---|---|
SNAPSHOT_PERIOD_UNSPECIFIED |
未设置。 |
ONE_HOUR |
1 小时。 |
SIX_HOURS |
6 小时。 |
TWELVE_HOURS |
12 小时。 |
TWENTY_FOUR_HOURS |
24 小时。 |
AOFConfig
基于 AOF 的持久性配置。
JSON 表示法 |
---|
{
"appendFsync": enum ( |
字段 | |
---|---|
appendFsync |
可选。fsync 模式。 |
AppendFsync
可能的 fsync 模式。
枚举 | |
---|---|
APPEND_FSYNC_UNSPECIFIED |
未设置。默认值:EVERY_SEC |
NEVER |
从不执行 fsync。正常情况下,Linux 会根据此配置每 30 秒刷新一次数据,但具体取决于内核的精确调整。 |
EVERY_SEC |
每秒执行一次 Fsync。如果发生灾难,您可能会丢失 1 秒的数据。 |
ALWAYS |
每次将新的写入命令附加到 AOF 时都进行 Fsync。以牺牲性能为代价,提供最佳数据丢失保护。 |
NodeConfig
表示实例节点的配置。
JSON 表示法 |
---|
{ "sizeGb": number } |
字段 | |
---|---|
sizeGb |
仅限输出。节点的内存大小(以 GB 为单位)。 |
ZoneDistributionConfig
用于分配实例资源的可用区分布配置。
JSON 表示法 |
---|
{
"zone": string,
"mode": enum ( |
字段 | |
---|---|
zone |
可选。定义将以 SINGLE_ZONE 模式分配所有资源的可用区。在 MULTI_ZONE 模式下会被忽略。 |
mode |
可选。当前区域分配模式。默认值为 MULTI_ZONE。 |
ZoneDistributionMode
可能的区域分布模式。
枚举 | |
---|---|
ZONE_DISTRIBUTION_MODE_UNSPECIFIED |
未设置。默认值:MULTI_ZONE |
MULTI_ZONE |
将资源分布在区域内随机选择的 3 个可用区中。 |
SINGLE_ZONE |
在单个可用区中配置资源。必须指定可用区字段。 |
PscAutoConnection
PSC 连接中使用方资源的详细信息。
JSON 表示法 |
---|
{ "pscConnectionId": string, "ipAddress": string, "forwardingRule": string, "projectId": string, "network": string, "serviceAttachment": string, "pscConnectionStatus": enum ( |
字段 | |
---|---|
pscConnectionId |
仅限输出。连接到服务连接的转发规则的 PSC 连接 ID。 |
ipAddress |
仅限输出。为 PSC 转发规则分配的使用方网络上的 IP。 |
forwardingRule |
仅限输出。使用方转发规则的 URI。格式:projects/{project}/区域/区域/forwardingRules/{forwardingRule} |
projectId |
必需。建立 PSC 连接的使用方项目 ID。这应与创建实例时所用的 projectId 相同。 |
network |
必需。创建 PSC 端点的网络,格式为 projects/{projectId}/global/networks/{network_id}。 |
serviceAttachment |
仅限输出。作为 PSC 连接的目标的服务连接,采用 projects/{project-id}/区域/区域/serviceAttachments/{service-attachment-id} 格式。 |
pscConnectionStatus |
仅限输出。PSC 连接的状态:是否存在有效连接,或者连接是否已不再存在。请注意,此值会定期更新。请使用 Private Service Connect API 获取最新状态。 |
connectionType |
仅限输出。PSC 连接的类型。 |
联合字段 ports 。公开端点的端口。ports 只能是下列其中一项: |
|
port |
可选。端口将仅针对主/读取器或发现端点设置。 |
PscConnectionStatus
PSC 连接的状态。
枚举 | |
---|---|
PSC_CONNECTION_STATUS_UNSPECIFIED |
未指定 PSC 连接状态。 |
ACTIVE |
连接处于有效状态 |
NOT_FOUND |
找不到连接 |
ConnectionType
PSC 连接的类型
枚举 | |
---|---|
CONNECTION_TYPE_UNSPECIFIED |
未设置连接类型 |
CONNECTION_TYPE_DISCOVERY |
将用于拓扑发现的连接。 |
CONNECTION_TYPE_PRIMARY |
将用作主要端点以访问主节点的连接。 |
CONNECTION_TYPE_READER |
将用作读取器端点以访问副本的连接。 |
PscAttachmentDetail
集群的服务连接的配置,用于创建 PSC 连接。
JSON 表示法 |
---|
{
"serviceAttachment": string,
"connectionType": enum ( |
字段 | |
---|---|
serviceAttachment |
仅限输出。您自行创建的 PscConnection 应使用的服务连接 URI 作为目标。 |
connectionType |
仅限输出。PSC 端点的类型。 |
InstanceEndpoint
InstanceEndpoint 由 PSC 连接组成,这些连接在每个 VPC 网络中以群组形式创建,用于访问实例。在每个组中,集群中的每个服务连接都应有一个连接。
JSON 表示法 |
---|
{
"connections": [
{
object ( |
字段 | |
---|---|
connections[] |
可选。一组 PSC 连接。它们是在同一 VPC 网络中创建的,集群中的每个服务连接对应一个。 |
ConnectionDetail
每个 PSC 连接的信息。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 connection 。与实例的 PSC 连接可以在集群创建期间通过服务连接自动化(自动连接)创建,也可以由客户自行创建(用户创建的连接)。connection 只能是下列其中一项: |
|
pscAutoConnection |
不可变。通过服务连接自动化功能创建的 PSC 连接的详细信息。 |
pscConnection |
用户创建的 PSC 连接的详细信息。 |
PscConnection
用户创建了 PSC 连接配置。
JSON 表示法 |
---|
{ "pscConnectionId": string, "ipAddress": string, "forwardingRule": string, "projectId": string, "network": string, "serviceAttachment": string, "pscConnectionStatus": enum ( |
字段 | |
---|---|
pscConnectionId |
必需。连接到服务连接的转发规则的 PSC 连接 ID。 |
ipAddress |
必需。为 PSC 转发规则分配的使用方网络上的 IP。 |
forwardingRule |
必需。使用方转发规则的 URI。格式:projects/{project}/区域/区域/forwardingRules/{forwardingRule} |
projectId |
仅限输出。创建转发规则的使用方项目 ID。 |
network |
必需。IP 地址所在的消费方网络,格式为 projects/{projectId}/global/networks/{network_id}。 |
serviceAttachment |
必需。作为 PSC 连接的目标的服务连接,采用 projects/{project-id}/区域/区域/serviceAttachments/{service-attachment-id} 格式。 |
pscConnectionStatus |
仅限输出。PSC 连接的状态:是否存在有效连接,或者连接是否已不再存在。请注意,此值会定期更新。请使用 Private Service Connect API 获取最新状态。 |
connectionType |
仅限输出。PSC 连接的类型。 |
联合字段 ports 。公开端点的端口。ports 只能是下列其中一项: |
|
port |
可选。端口将仅针对主/读取器或发现端点设置。 |
模式
用于启用/停用集群模式的模式配置。
枚举 | |
---|---|
MODE_UNSPECIFIED |
未指定模式。 |
STANDALONE |
已弃用:请改用 CLUSTER_DISABLED。 |
CLUSTER |
实例处于集群模式。 |
CLUSTER_DISABLED |
实例已停用集群模式。 |
MaintenancePolicy
每个实例的维护政策。
JSON 表示法 |
---|
{
"createTime": string,
"updateTime": string,
"weeklyMaintenanceWindow": [
{
object ( |
字段 | |
---|---|
createTime |
仅限输出。政策的创建时间。 采用 RFC 3339 标准,生成的输出将始终在末尾带 Z,并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
updateTime |
仅限输出。政策的更新时间。 采用 RFC 3339 标准,生成的输出将始终在末尾带 Z,并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
weeklyMaintenanceWindow[] |
可选。应用于相应政策所涵盖资源的维护窗口。最小值为 1。对于当前版本,weekly_window 的最大数量应为 1。 |
WeeklyMaintenanceWindow
为每周运营指定的时间窗口。
JSON 表示法 |
---|
{ "day": enum ( |
字段 | |
---|---|
day |
可选。允许定义在每周指定日期运行的时间表。 |
startTime |
可选。时间段的开始时间(以世界协调时间 [UTC] 表示)。 |
MaintenanceSchedule
即将进行的维护的时间表。
JSON 表示法 |
---|
{ "startTime": string, "endTime": string } |
字段 | |
---|---|
startTime |
仅限输出。此实例的任何近期维护的开始时间。 采用 RFC 3339 标准,生成的输出将始终在末尾带 Z,并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
endTime |
仅限输出。此实例的任何近期维护的结束时间。 采用 RFC 3339 标准,生成的输出将始终在末尾带 Z,并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
CrossInstanceReplicationConfig
跨实例复制配置。
JSON 表示法 |
---|
{ "instanceRole": enum ( |
字段 | |
---|---|
instanceRole |
必需。实例在跨实例复制中的角色。 |
primaryInstance |
可选。用作相应次要实例的复制来源的主实例的详细信息。 此字段仅针对辅助实例设置。 |
secondaryInstances[] |
可选。正在从此主实例复制的次要实例的列表。 此字段仅针对主实例设置。 |
updateTime |
仅限输出。上次更新跨实例复制配置的时间。 采用 RFC 3339 标准,生成的输出将始终在末尾带 Z,并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
membership |
仅限输出。参与跨实例复制的所有成员实例的只输出视图。每个成员实例(无论其实例角色是主实例还是次要实例)都会提供此视图。 主实例可以提供有关所有从其复制的辅助实例的信息。不过,辅助实例只知道它正在复制的主实例。不过,在主实例不可用的情况下(例如区域性中断),可以将 Getinstance 请求发送到任何其他成员实例,并且此字段将列出参与跨实例复制的所有成员实例。 |
InstanceRole
实例在跨实例复制中的角色。
枚举 | |
---|---|
INSTANCE_ROLE_UNSPECIFIED |
未设置实例角色。此行为等同于 NONE。 |
NONE |
此实例不参与跨实例复制。它是一个独立实例,不会复制到任何其他实例或从任何其他实例复制。 |
PRIMARY |
允许读取和写入的实例。写入此实例的所有数据也会复制到所连接的辅助实例。 |
SECONDARY |
仅允许读取并从主实例复制数据的实例。 |
RemoteInstance
在跨实例复制设置中与此实例关联的远程实例的详细信息。
JSON 表示法 |
---|
{ "instance": string, "uid": string } |
字段 | |
---|---|
instance |
可选。远程实例的完整资源路径,格式为:projects/ |
uid |
仅限输出。远程实例的唯一标识符。 |
成员
参与跨实例复制的所有成员实例的只输出视图。
JSON 表示法 |
---|
{ "primaryInstance": { object ( |
字段 | |
---|---|
primaryInstance |
仅限输出。充当次要实例复制来源的主实例。 |
secondaryInstances[] |
仅限输出。从主实例复制的辅助实例的列表。 |
AutomatedBackupConfig
实例的自动备份配置。
JSON 表示法 |
---|
{ "automatedBackupMode": enum ( |
字段 | |
---|---|
automatedBackupMode |
可选。自动备份模式。如果该模式处于停用状态,系统会忽略其他字段。 |
retention |
可选。自动备份在被删除之前的保留时长。该值应介于 1 天到 365 天之间。如果未指定,则默认值为 35 天。 该时长以秒为单位,最多包含九个小数位,以“ |
联合字段 schedule 。自动备份的安排。schedule 只能是下列其中一项: |
|
fixedFrequencySchedule |
可选。以固定频率触发自动备份。 |
FixedFrequencySchedule
此时间表允许以固定频率(目前仅支持每天)触发备份。
JSON 表示法 |
---|
{
"startTime": {
object ( |
字段 | |
---|---|
startTime |
必需。每次自动备份的开始时间(以世界协调时间 [UTC] 表示)。必须设置为某个小时的开始时间。此字段是必填字段。 |
AutomatedBackupMode
自动备份模式。
枚举 | |
---|---|
AUTOMATED_BACKUP_MODE_UNSPECIFIED |
默认值。未指定自动备份配置。 |
DISABLED |
已停用自动备份配置。 |
ENABLED |
已启用自动备份配置。 |
方法 |
|
---|---|
|
备份实例。 |
|
在给定的项目和位置中创建一个新实例。 |
|
删除单个实例。 |
|
获取单个实例的详细信息。 |
|
获取有关实例的证书授权机构的详细信息。 |
|
列出给定项目和位置中的实例。 |
|
更新单个实例的参数。 |
|
重新安排即将进行的维护事件。 |