REST Resource: projects.locations.instances

资源:实例

Memorystore 实例。

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)
  },
  "aclPolicyInfo": {
    object (AclPolicyInfo)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "gcsSource": {
    object (GcsBackupSource)
  },
  "managedBackupSource": {
    object (ManagedBackupSource)
  }
  // End of mutually exclusive fields.
  "replicaCount": integer,
  "deletionProtectionEnabled": boolean,
  "simulateMaintenanceEvent": boolean,
  "ondemandMaintenance": boolean,
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean,
  "asyncInstanceEndpointsDeletionEnabled": boolean,
  "kmsKey": string,
  "backupCollection": string,
  "maintenanceVersion": string,
  "effectiveMaintenanceVersion": string,
  "serverCaMode": enum (ServerCaMode),
  "serverCaPool": string,
  "rotateServerCertificate": boolean,
  "aclPolicy": string,
  "aclPolicyInSync": boolean
}
字段
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)

仅限输出。已弃用:discoveryEndpoints 参数已被弃用。因此,如果使用端点参数创建连接,则不会填充此字段。对于发现,请使用 endpoints.connections.pscConnection 和 endpoints.connections.pscAutoConnection 以及 connectionType CONNECTION_TYPE_DISCOVERY,而不是此参数。

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)

仅限输出。实例的迁移配置。

aclPolicyInfo

object (AclPolicyInfo)

仅限输出。已应用的 ACL 政策的详细信息。

导入来源。以下是互斥字段的列表。在响应中,最多只能设置以下字段之一:
gcsSource

object (GcsBackupSource)

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

managedBackupSource

object (ManagedBackupSource)

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

互斥字段的结束。
replicaCount

integer

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

deletionProtectionEnabled

boolean

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

simulateMaintenanceEvent

boolean

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

ondemandMaintenance
(deprecated)

boolean

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

satisfiesPzs

boolean

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

satisfiesPzi

boolean

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

asyncInstanceEndpointsDeletionEnabled

boolean

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

kmsKey

string

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

backupCollection

string

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

maintenanceVersion

string

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

effectiveMaintenanceVersion

string

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

serverCaMode

enum (ServerCaMode)

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

serverCaPool

string

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

rotateServerCertificate

boolean

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

aclPolicy

string

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

aclPolicyInSync
(deprecated)

boolean

仅限输出。已弃用:应用于实例的 ACL 规则是否处于同步状态。

GcsBackupSource

存储在 Cloud Storage 存储桶中的备份。Cloud Storage 存储桶需要与实例位于同一区域。

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

string

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

ManagedBackupSource

由 Memorystore 生成和管理的备份。

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

string

可选。示例://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 正在删除实例。
MIGRATING 正在迁移实例。

StateInfo

有关实例状态的其他信息。

JSON 表示法
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "updateInfo": {
    object (UpdateInfo)
  }
  // End of mutually exclusive fields.
}
字段
以下是互斥字段的列表。在响应中,最多只能设置以下字段之一:
updateInfo

object (UpdateInfo)

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

互斥字段的结束。

UpdateInfo

表示状态为 UPDATING 的实例的相关信息。

JSON 表示法
{
  "targetShardCount": integer,
  "targetReplicaCount": integer,
  "targetEngineVersion": string,
  "targetNodeType": enum (NodeType)
}
字段
targetShardCount

integer

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

targetReplicaCount

integer

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

targetEngineVersion

string

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

targetNodeType

enum (NodeType)

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

AuthorizationMode

实例的可能授权模式。

枚举
AUTHORIZATION_MODE_UNSPECIFIED 未设置。
AUTH_DISABLED 授权已停用。
IAM_AUTH IAM 基本授权。
TOKEN_AUTH 基于令牌的授权。

TransitEncryptionMode

实例可能采用的传输加密模式。

枚举
TRANSIT_ENCRYPTION_MODE_UNSPECIFIED 未设置。
TRANSIT_ENCRYPTION_DISABLED 传输加密已停用。
SERVER_AUTHENTICATION 服务器管理的加密用于传输加密。

DiscoveryEndpoint

表示供客户端连接到实例的端点。

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

string

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

port

integer

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

network

string

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

PersistenceConfig

表示实例的持久性配置。

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

enum (PersistenceMode)

可选。当前持久性模式。

rdbConfig

object (RDBConfig)

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

aofConfig

object (AOFConfig)

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

PersistenceMode

可能的持久性模式。

枚举
PERSISTENCE_MODE_UNSPECIFIED 未设置。
DISABLED 持久性已停用,所有快照数据均已删除。
RDB 已启用基于 RDB 的持久化功能。
AOF 已启用基于 AOF 的持久性。

RDBConfig

基于 RDB 的持久化功能的配置。

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

SnapshotPeriod

可能的快照时间段。

枚举
SNAPSHOT_PERIOD_UNSPECIFIED 未设置。
ONE_HOUR 1 小时。
SIX_HOURS 6 小时。
TWELVE_HOURS 12 小时。
TWENTY_FOUR_HOURS 24 小时。

AOFConfig

基于 AOF 的持久性配置。

JSON 表示法
{
  "appendFsync": enum (AppendFsync)
}
字段
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

number

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

ZoneDistributionConfig

用于分配实例资源的可用区分布配置。

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

string

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

zones[]

string

可选。指定多可用区实例的可用区,Memorystore 实例将在这些可用区中分配资源。此标志不适用于单可用区实例。

mode

enum (ZoneDistributionMode)

可选。当前区域分配模式。默认值为 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 (PscConnectionStatus),
  "connectionType": enum (ConnectionType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "port": integer
  // End of mutually exclusive fields.
}
字段
pscConnectionId

string

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

ipAddress

string

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

forwardingRule

string

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

projectId

string

必需。建立 PSC 连接的使用方项目 ID。这应与创建实例时所用的 projectId 相同。

network

string

必需。创建 PSC 端点的网络,格式为 projects/{projectId}/global/networks/{network_name}。

serviceAttachment

string

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

pscConnectionStatus

enum (PscConnectionStatus)

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

connectionType

enum (ConnectionType)

仅限输出。PSC 连接的类型。

公开端点的端口。以下是互斥字段的列表。在响应中,最多只能设置以下字段之一:
port

integer

可选。仅会为主要/读取器或发现端点设置端口。

互斥字段的结束。

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 (ConnectionType)
}
字段
serviceAttachment

string

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

connectionType

enum (ConnectionType)

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

InstanceEndpoint

InstanceEndpoint 由 PSC 连接组成,这些连接在每个 VPC 网络中以组的形式创建,用于访问实例。在每个组中,集群中的每个服务连接都应有一个连接。

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

object (ConnectionDetail)

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

ConnectionDetail

每个 PSC 连接的信息。

JSON 表示法
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "pscAutoConnection": {
    object (PscAutoConnection)
  },
  "pscConnection": {
    object (PscConnection)
  }
  // End of mutually exclusive fields.
}
字段
与实例的 PSC 连接可以在集群创建期间通过服务连接自动化(自动连接)创建,也可以由客户自行创建(用户创建的连接)。以下是互斥字段的列表。在响应中,最多只能设置以下字段之一:
pscAutoConnection

object (PscAutoConnection)

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

pscConnection

object (PscConnection)

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

互斥字段的结束。

PscConnection

用户创建的 PSC 连接配置。

JSON 表示法
{
  "pscConnectionId": string,
  "ipAddress": string,
  "forwardingRule": string,
  "projectId": string,
  "network": string,
  "serviceAttachment": string,
  "pscConnectionStatus": enum (PscConnectionStatus),
  "connectionType": enum (ConnectionType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "port": integer
  // End of mutually exclusive fields.
}
字段
pscConnectionId

string

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

ipAddress

string

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

forwardingRule

string

必需。使用方端转发规则的 URI。格式:projects/{project}/区域/区域/forwardingRules/{forwardingRule}

projectId

string

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

network

string

必需。IP 地址所在的消费方网络,格式为 projects/{projectId}/global/networks/{network_name}。

serviceAttachment

string

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

pscConnectionStatus

enum (PscConnectionStatus)

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

connectionType

enum (ConnectionType)

仅限输出。PSC 连接的类型。

公开端点的端口。以下是互斥字段的列表。在响应中,最多只能设置以下字段之一:
port

integer

可选。仅会为主要/读取器或发现端点设置端口。

互斥字段的结束。

模式

用于启用/停用集群模式的模式配置。

枚举
MODE_UNSPECIFIED 未指定模式。
STANDALONE

已弃用:请改用 CLUSTER_DISABLED。

CLUSTER 实例处于集群模式。
CLUSTER_DISABLED 实例的集群模式已停用。

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 (DayOfWeek),
  "startTime": {
    object (TimeOfDay)
  }
}
字段
day

enum (DayOfWeek)

可选。允许定义在指定星期几运行的时间表。

startTime

object (TimeOfDay)

可选。时段的开始时间(世界协调时间)。

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 请求,并且此字段将列出参与跨实例复制的所有成员实例。

InstanceRole

实例在跨实例复制中的角色。

枚举
INSTANCE_ROLE_UNSPECIFIED 未设置实例角色。此行为等同于 NONE。
NONE 此实例不参与跨实例复制。它是一个独立实例,不会复制到任何其他实例或从任何其他实例复制。
PRIMARY 允许读取和写入的实例。写入此实例的任何数据也会复制到所连接的次要实例。
SECONDARY 仅允许读取数据并从主实例复制数据的实例。

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)

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

AutomatedBackupConfig

实例的自动备份配置。

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "fixedFrequencySchedule": {
    object (FixedFrequencySchedule)
  }
  // End of mutually exclusive fields.
}
字段
automatedBackupMode

enum (AutomatedBackupMode)

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

retention

string (Duration format)

可选。自动备份的保留时长,该期限过后会自动删除备份。该值应介于 1 天到 365 天之间。如果未指定,则默认值为 35 天。

该时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"。

自动备份的时间表。以下是互斥字段的列表。在响应中,最多只能设置以下字段之一:
fixedFrequencySchedule

object (FixedFrequencySchedule)

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

互斥字段的结束。

FixedFrequencySchedule

此时间表允许以固定频率(目前仅支持每天)触发备份。

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

object (TimeOfDay)

必需。每次自动备份的开始时间(世界协调时间)。必须设置为某个小时的开始时间。此字段是必填字段。

AutomatedBackupMode

自动备份模式。

枚举
AUTOMATED_BACKUP_MODE_UNSPECIFIED 默认值。未指定自动备份配置。
DISABLED 已停用自动备份配置。
ENABLED 已启用自动备份配置。

ServerCaMode

实例的服务器 CA 模式。

枚举
SERVER_CA_MODE_UNSPECIFIED 未指定服务器 CA 模式。
GOOGLE_MANAGED_PER_INSTANCE_CA 每个实例都有自己的 Google 管理的 CA。
GOOGLE_MANAGED_SHARED_CA 实例使用 Google 管理的共享 CA(适用于实例的区域)。
CUSTOMER_MANAGED_CAS_CA 实例使用 CAS 中的客户管理的 CA。
SERVER_CA_MODE_GOOGLE_MANAGED_PER_INSTANCE_CA

已弃用:请改用 GOOGLE_MANAGED_PER_INSTANCE_CA。

SERVER_CA_MODE_GOOGLE_MANAGED_SHARED_CA

已弃用:请改用 GOOGLE_MANAGED_SHARED_CA。

SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA

已弃用:请改用 CUSTOMER_MANAGED_CAS_CA。

MigrationConfig

实例迁移的配置。

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "selfManagedSource": {
    object (SelfManagedSource)
  }
  // End of mutually exclusive fields.
}
字段
state

enum (State)

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

forceFinishMigration

boolean

仅限输出。表示一个布尔值标志,用于在停止复制之前强制完成迁移,而无需在源和目标之间进行偏移量追赶验证。

有关迁移来源的详细信息。以下是互斥字段的列表。在响应中,最多只能设置以下字段之一:
selfManagedSource

object (SelfManagedSource)

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

互斥字段的结束。

SelfManagedSource

自行管理的源实例的详细信息。

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

string

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

port

integer

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

networkAttachment

string

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

格式:projects/{project}/区域/区域/networkAttachments/{networkAttachment}

州

实例的迁移状态。未来可能会添加新值。

枚举
STATE_UNSPECIFIED 实例没有与迁移相关的活动。这是初始状态。
ROLLED_BACK 实例目前未在迁移。实例尝试迁移失败,但后续回滚成功。如果需要,该实例现在可以再次尝试迁移。
ROLLING_BACK 表示之前的迁移尝试失败。高级实例状态将为 MIGRATING。实例尚未准备好进行新的迁移尝试。正在进行回滚,以将实例恢复到原始状态。在回滚成功之前,实例将一直处于此状态。
REPLICATION_ESTABLISHED 实例正在迁移。实例已成功建立复制,可以进行割接。
MIGRATED 实例已成功迁移。

AclPolicyInfo

已应用的 ACL 政策的详细信息。

JSON 表示法
{
  "appliedAclPolicy": string,
  "appliedAclPolicyRevision": string,
  "appliedAclPolicyRevisionNumber": string,
  "aclPolicyRevisionStatuses": [
    {
      object (AclPolicyRevisionStatus)
    }
  ]
}
字段
appliedAclPolicy

string

仅限输出。已应用的 ACL 政策的资源名称。格式:“projects/{project}/locations/{location}/aclPolicies/{aclPolicy}”

appliedAclPolicyRevision

string

仅限输出。已应用的 ACL 政策修订版本的资源名称。格式:“projects/{project}/locations/{location}/aclPolicies/{aclPolicy}/revisions/{revision}”

appliedAclPolicyRevisionNumber

string (int64 format)

仅限输出。所应用 ACL 政策修订版本的修订版本号。

aclPolicyRevisionStatuses[]

object (AclPolicyRevisionStatus)

仅限输出。相应实例上此 ACL 政策的各个修订版本的状态列表。

方法

addTokenAuthUser

为启用了基于令牌的身份验证的实例添加了基于令牌的身份验证用户。

backup

备份实例。

create

在给定的项目和位置中创建一个新实例。

delete

删除单个实例。

finishMigration

完成迁移流程。

get

获取单个实例的详细信息。

getCertificateAuthority

获取实例的证书授权机构的相关详细信息。

list

列出给定项目和位置中的实例。

patch

更新单个实例的参数。

rescheduleMaintenance

重新安排即将进行的维护事件。

startMigration

启动从源实例到目标 Memorystore 实例的迁移。