- 资源:Cluster
- GcsBackupSource
- ManagedBackupSource
- 状态
- AuthorizationMode
- TransitEncryptionMode
- PscConfig
- DiscoveryEndpoint
- PscConnection
- PscConnectionStatus
- ConnectionType
- StateInfo
- UpdateInfo
- ClusterPersistenceConfig
- PersistenceMode
- RDBConfig
- SnapshotPeriod
- AOFConfig
- AppendFsync
- ZoneDistributionConfig
- ZoneDistributionMode
- CrossClusterReplicationConfig
- ClusterRole
- RemoteCluster
- 会员
- ClusterMaintenancePolicy
- ClusterWeeklyMaintenanceWindow
- ClusterMaintenanceSchedule
- PscServiceAttachment
- ClusterEndpoint
- ConnectionDetail
- PscAutoConnection
- AutomatedBackupConfig
- FixedFrequencySchedule
- AutomatedBackupMode
- 方法
资源:Cluster
集群实例。
JSON 表示法 |
---|
{ "name": string, "createTime": string, "state": enum ( |
字段 | |
---|---|
name |
必需。标识符。此范围内资源采用以下形式的非重复名称,包括项目和位置: |
createTime |
仅限输出。与集群创建请求相关联的时间戳。 采用 RFC 3339 标准,生成的输出将始终在末尾带 Z,并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
state |
仅限输出。相应集群的当前状态。可以是 CREATING、READY、UPDATING、DELETING 和 SUSPENDED |
uid |
仅限输出。系统为集群分配的唯一标识符。 |
authorizationMode |
可选。Redis 集群的授权模式。如果未提供,则为集群停用身份验证功能。 |
transitEncryptionMode |
可选。Redis 集群的传输加密。如果未提供,则系统会为集群停用加密功能。 |
pscConfigs[] |
可选。每个 PscConfig 都会配置使用方网络,其中 IP 将指定给集群,以便通过 Private Service Connect 自动化实现客户端访问。目前,仅支持一个 PscConfig。 |
discoveryEndpoints[] |
仅限输出。在每个指定网络上创建的端点,供 Redis 客户端连接到集群。目前仅支持一个发现端点。 |
pscConnections[] |
仅限输出。通过服务连接自动化自动创建的 PSC 连接的列表。 |
stateInfo |
仅限输出。有关集群当前状态的其他信息。 |
nodeType |
可选。集群中 Redis 节点的类型。NodeType 决定了 Redis 节点的底层机器类型。 |
persistenceConfig |
可选。集群的持久性配置(RDB、AOF)。 |
redisConfigs |
可选。可变 Redis 配置的客户替换项的键值对 包含一系列 |
zoneDistributionConfig |
可选。此配置将用于确定客户希望我们在区域内如何分配集群资源。 |
crossClusterReplicationConfig |
可选。跨集群复制配置。 |
pscServiceAttachments[] |
仅限输出。用于配置 PSC 连接的服务连接详情 |
clusterEndpoints[] |
可选。集群端点的列表。 |
automatedBackupConfig |
可选。集群的自动备份配置。 |
encryptionInfo |
仅限输出。集群静态数据的加密信息。 |
allowFewerZonesDeployment |
可选。不可变。允许客户指定是否可以接受在少于 3 个可用区中部署多可用区集群。设置后,如果在集群创建期间发生可用区中断,集群将仅部署在 2 个可用区中,并在其生命周期内保持在这 2 个可用区中。 |
联合字段 import_sources 。要导入的来源。import_sources 只能是下列其中一项: |
|
gcsSource |
可选。存储在 Cloud Storage 存储分区中的备份。Cloud Storage 存储分区需要与集群位于同一区域。必须具有读取权限才能从提供的 Cloud Storage 对象导入数据。 |
managedBackupSource |
可选。由 Memorystore 服务生成和管理的备份。 |
replicaCount |
可选。每个分片的副本节点数。 |
sizeGb |
仅限输出。整个集群的 Redis 内存大小(以 GB 为单位),向上舍入为下一个整数。 |
shardCount |
可选。Redis 集群的分片数。 |
preciseSizeGb |
仅限输出。整个集群的 Redis 内存大小(以 GB 为单位)的精确值。 |
deletionProtectionEnabled |
可选。当该值设置为 true 时,删除操作将失败。 |
maintenancePolicy |
可选。ClusterMaintenancePolicy 决定了何时允许或拒绝更新。 |
maintenanceSchedule |
仅限输出。ClusterMaintenanceSchedule 仅限输出已发布的维护时间表。 |
simulateMaintenanceEvent |
可选。仅限输入。模拟维护事件。 |
backupCollection |
可选。仅限输出。备份集合的完整资源名称。示例:projects/{project}/locations/{location}/backupCollections/{collection} |
kmsKey |
可选。用于加密集群静态数据的 KMS 密钥。 |
ondemandMaintenance |
可选。仅限输入。集群的按需维护。此字段可用于触发集群上的按需关键更新。 |
asyncClusterEndpointsDeletionEnabled |
可选。如果为 true,则客户创建和注册的集群端点可以异步删除。也就是说,可以在删除集群端点中的转发规则之前取消注册此类集群端点。 |
GcsBackupSource
存储在 Cloud Storage 存储分区中的备份。Cloud Storage 存储分区需要与集群位于同一区域。
JSON 表示法 |
---|
{ "uris": [ string ] } |
字段 | |
---|---|
uris[] |
可选。要导入的 Cloud Storage 对象的 URI。示例:gs://bucket1/object1、gs://bucket2/folder2/object2 |
ManagedBackupSource
由 Memorystore 生成和管理的备份。
JSON 表示法 |
---|
{ "backup": string } |
字段 | |
---|---|
backup |
可选。示例://redis.googleapis.com/projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup} 系统还支持较短版本的备份名称(不带前缀),例如 projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backupId} 在这种情况下,系统会假定备份位于 redis.googleapis.com 下。 |
州
表示 Redis 集群的不同状态。
枚举 | |
---|---|
STATE_UNSPECIFIED |
未设置。 |
CREATING |
正在创建 Redis 集群。 |
ACTIVE |
Redis 集群已创建并且完全可用。 |
UPDATING |
Redis 集群配置正在更新。 |
DELETING |
正在删除 Redis 集群。 |
AuthorizationMode
Redis 集群的可用授权模式。
枚举 | |
---|---|
AUTH_MODE_UNSPECIFIED |
未设置。 |
AUTH_MODE_IAM_AUTH |
IAM 基本授权模式 |
AUTH_MODE_DISABLED |
授权停用模式 |
TransitEncryptionMode
可用的传输加密模式。
枚举 | |
---|---|
TRANSIT_ENCRYPTION_MODE_UNSPECIFIED |
未设置传输加密。 |
TRANSIT_ENCRYPTION_MODE_DISABLED |
传输加密已停用。 |
TRANSIT_ENCRYPTION_MODE_SERVER_AUTHENTICATION |
使用服务器管理的加密进行传输加密。 |
PscConfig
JSON 表示法 |
---|
{ "network": string } |
字段 | |
---|---|
network |
必需。将预留发现端点 IP 地址的网络,格式为 projects/{networkProject}/global/networks/{network_id}。 |
DiscoveryEndpoint
每个网络上的端点,供 Redis 客户端连接到集群。
JSON 表示法 |
---|
{
"address": string,
"port": integer,
"pscConfig": {
object ( |
字段 | |
---|---|
address |
仅限输出。客户端用于连接到服务的公开 Redis 端点的地址。该地址可以是 IP 地址,也可以是主机名。 |
port |
仅限输出。公开 Redis 端点的端口号。 |
pscConfig |
仅限输出。客户配置,用于指定端点的创建位置和访问位置。 |
PscConnection
PSC 连接中使用方资源的详细信息。
JSON 表示法 |
---|
{ "pscConnectionId": string, "address": string, "forwardingRule": string, "projectId": string, "network": string, "serviceAttachment": string, "pscConnectionStatus": enum ( |
字段 | |
---|---|
pscConnectionId |
必需。连接到服务连接的转发规则的 PSC 连接 ID。 |
address |
必需。为 PSC 转发规则在使用方网络上分配的 IP。 |
forwardingRule |
必需。使用方转发规则的 URI。示例:projects/{projectNumOrId}/区域/us-east1/forwardingRules/{resourceId}。 |
projectId |
可选。创建转发规则的使用方项目的项目 ID。 |
network |
必需。IP 地址所在的消费方网络,格式为 projects/{projectId}/global/networks/{network_id}。 |
serviceAttachment |
必需。作为 PSC 连接的目标的服务连接,采用 projects/{project-id}/区域/区域/serviceAttachments/{service-attachment-id} 格式。 |
pscConnectionStatus |
仅限输出。PSC 连接的状态。请注意,此值会定期更新。如需了解 PSC 连接的最新状态,请访问 https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details。 |
connectionType |
仅限输出。PSC 连接的类型。 |
联合字段 ports 。公开的发现端点的端口号。ports 只能是下列其中一项: |
|
port |
仅限输出。端口仅会针对主/读取器或发现端点进行设置。 |
PscConnectionStatus
PSC 连接的状态。
枚举 | |
---|---|
PSC_CONNECTION_STATUS_UNSPECIFIED |
未指定 PSC 连接状态。 |
PSC_CONNECTION_STATUS_ACTIVE |
关联处于有效状态 |
PSC_CONNECTION_STATUS_NOT_FOUND |
找不到连接 |
ConnectionType
PSC 连接的类型,用于集群访问。
枚举 | |
---|---|
CONNECTION_TYPE_UNSPECIFIED |
未设置集群端点类型 |
CONNECTION_TYPE_DISCOVERY |
将用作集群拓扑发现的集群端点。 |
CONNECTION_TYPE_PRIMARY |
将用作主要端点以访问主节点的集群端点。 |
CONNECTION_TYPE_READER |
将用作读取器端点以访问副本的集群端点。 |
StateInfo
表示有关集群状态的其他信息。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段
|
|
updateInfo |
当集群状态为 UPDATING 时,描述集群上正在进行的更新。 |
UpdateInfo
表示有关正在更新的集群的信息。
JSON 表示法 |
---|
{
"targetShardCount": integer,
"targetReplicaCount": integer,
"targetNodeType": enum ( |
字段 | |
---|---|
targetShardCount |
Redis 集群的目标分片数 |
targetReplicaCount |
每个分片的副本节点的目标数量。 |
targetNodeType |
Redis 集群的目标节点类型。 |
ClusterPersistenceConfig
持久性功能的配置。
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 |
未设置。默认值:EVERYSEC |
NO |
从不执行 fsync。正常情况下,Linux 会根据此配置每 30 秒刷新一次数据,但具体取决于内核的精确调整。 |
EVERYSEC |
每秒执行一次 fsync。足够快,如果发生灾难,您可能会丢失 1 秒的数据 |
ALWAYS |
每次将新的写入命令附加到 AOF 时都进行 fsync。它具有最佳的数据丢失保护功能,但会牺牲性能 |
ZoneDistributionConfig
用于分配集群资源的可用区分布配置。
JSON 表示法 |
---|
{
"mode": enum ( |
字段 | |
---|---|
mode |
可选。可用区分布模式。如果未指定,则默认为 MULTI_ZONE。 |
zone |
可选。选择“单可用区”分布后,系统会使用可用区字段在该可用区中分配所有资源。这不适用于 MULTI_ZONE,并且对于 MULTI_ZONE 集群会被忽略。 |
ZoneDistributionMode
定义各种区域分布模式。
枚举 | |
---|---|
ZONE_DISTRIBUTION_MODE_UNSPECIFIED |
未设置。默认值:MULTI_ZONE |
MULTI_ZONE |
在区域内随机选择 3 个可用区,并在其中分配所有资源。 |
SINGLE_ZONE |
将所有资源分布在单个可用区中。选择此模式时,必须指定可用区字段。 |
CrossClusterReplicationConfig
跨集群复制配置。
JSON 表示法 |
---|
{ "clusterRole": enum ( |
字段 | |
---|---|
clusterRole |
仅限输出。集群在跨集群复制中的角色。 |
primaryCluster |
用作相应次要集群的复制源的主要集群的详细信息。 此字段仅针对辅助集群设置。 |
secondaryClusters[] |
正在从此主要集群复制数据的次要集群的列表。 此字段仅针对主集群设置。 |
updateTime |
仅限输出。上次更新跨集群复制配置的时间。 采用 RFC 3339 标准,生成的输出将始终在末尾带 Z,并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
membership |
仅限输出。仅显示参与跨集群复制的所有成员集群的输出视图。无论成员集群的角色(主集群或次要集群)如何,每个成员集群都会提供此视图。 主集群可以提供有关从其复制数据的所有次集群的信息。不过,次要集群只知道它正在复制的主集群。不过,在主集群不可用的情况下(例如区域性中断),可以将 clusters.get 请求发送到任何其他成员集群,并且此字段将列出参与跨集群复制的所有成员集群。 |
ClusterRole
集群在跨集群复制中的角色。
枚举 | |
---|---|
CLUSTER_ROLE_UNSPECIFIED |
未设置集群角色。此行为等同于 NONE。 |
NONE |
此集群不参与跨集群复制。它是一个独立集群,不会复制到任何其他集群,也不会从任何其他集群复制。 |
PRIMARY |
允许读取和写入的集群。写入此集群的任何数据也会复制到关联的次要集群。 |
SECONDARY |
仅允许读取并从主集群复制数据的集群。 |
RemoteCluster
在跨集群复制设置中与相应集群关联的远程集群的详细信息。
JSON 表示法 |
---|
{ "cluster": string, "uid": string } |
字段 | |
---|---|
cluster |
仅限输出。远程集群的完整资源路径,格式为:projects/ |
uid |
仅限输出。远程集群的唯一标识符。 |
成员
仅显示参与跨集群复制的所有成员集群的输出视图。
JSON 表示法 |
---|
{ "primaryCluster": { object ( |
字段 | |
---|---|
primaryCluster |
仅限输出。充当次要集群复制源的主要集群。 |
secondaryClusters[] |
仅限输出。从主集群复制数据的次要集群的列表。 |
ClusterMaintenancePolicy
每个集群的维护政策。
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。对于当前版本,weeklyMaintenanceWindow 的最大数量应为 1。 |
ClusterWeeklyMaintenanceWindow
为每周运营指定的时间窗口。
JSON 表示法 |
---|
{ "day": enum ( |
字段 | |
---|---|
day |
可选。允许定义在每周指定日期运行的时间表。 |
startTime |
可选。时间段的开始时间(以世界协调时间 [UTC] 表示)。 |
ClusterMaintenanceSchedule
即将进行的维护的时间表。
JSON 表示法 |
---|
{ "startTime": string, "endTime": string } |
字段 | |
---|---|
startTime |
仅限输出。此实例的任何近期维护的开始时间。 采用 RFC 3339 标准,生成的输出将始终在末尾带 Z,并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
endTime |
仅限输出。此实例的任何近期维护的结束时间。 采用 RFC 3339 标准,生成的输出将始终在末尾带 Z,并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
PscServiceAttachment
集群的服务连接的配置,用于创建 PSC 连接。
JSON 表示法 |
---|
{
"serviceAttachment": string,
"connectionType": enum ( |
字段 | |
---|---|
serviceAttachment |
仅限输出。您自行创建的 PscConnection 应使用的服务连接 URI 作为目标 |
connectionType |
仅限输出。指向相应服务连接的 PSC 连接的类型。 |
ClusterEndpoint
ClusterEndpoint 由 PSC 连接组成,这些连接在每个 VPC 网络中以群组形式创建,用于访问集群。在每个组中,集群中的每个服务连接都应有一个连接。
JSON 表示法 |
---|
{
"connections": [
{
object ( |
字段 | |
---|---|
connections[] |
必需。一组 PSC 连接。它们是在同一 VPC 网络中创建的,集群中的每个服务连接对应一个。 |
ConnectionDetail
每个 PSC 连接的详细信息。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 connection 。与集群的 PSC 连接可以在集群创建期间通过服务连接自动化功能(自动注册的连接)创建,也可以由客户自行创建(用户注册的连接)。connection 只能是下列其中一项: |
|
pscAutoConnection |
通过服务连接自动化功能创建的 PSC 连接的详细信息。 |
pscConnection |
集群所有者客户创建的 PSC 连接的详细信息。 |
PscAutoConnection
通过服务连接自动化创建的 PSC 连接中使用方资源的详细信息。
JSON 表示法 |
---|
{ "pscConnectionId": string, "address": string, "forwardingRule": string, "projectId": string, "network": string, "serviceAttachment": string, "pscConnectionStatus": enum ( |
字段 | |
---|---|
pscConnectionId |
仅限输出。连接到服务连接的转发规则的 PSC 连接 ID。 |
address |
仅限输出。为 PSC 转发规则在使用方网络上分配的 IP。 |
forwardingRule |
仅限输出。使用方转发规则的 URI。示例:projects/{projectNumOrId}/区域/us-east1/forwardingRules/{resourceId}。 |
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 连接的类型。 |
AutomatedBackupConfig
集群的自动备份配置。
JSON 表示法 |
---|
{ "automatedBackupMode": enum ( |
字段 | |
---|---|
automatedBackupMode |
可选。自动备份模式。如果该模式处于停用状态,系统会忽略其他字段。 |
联合字段 schedule 。自动备份的安排。schedule 只能是下列其中一项: |
|
fixedFrequencySchedule |
可选。以固定频率触发自动备份。 |
retention |
可选。自动备份在被删除之前的保留时长。该值应介于 1 天到 365 天之间。如果未指定,则默认值为 35 天。 该时长以秒为单位,最多包含九个小数位,以“ |
FixedFrequencySchedule
此时间表允许以固定频率(目前仅支持每天)触发备份。
JSON 表示法 |
---|
{
"startTime": {
object ( |
字段 | |
---|---|
startTime |
必需。每次自动备份的开始时间(以世界协调时间 [UTC] 表示)。必须设置为某个小时的开始时间。此字段是必填字段。 |
AutomatedBackupMode
自动备份模式。
枚举 | |
---|---|
AUTOMATED_BACKUP_MODE_UNSPECIFIED |
默认值。未指定自动备份配置。 |
DISABLED |
已停用自动备份配置。 |
ENABLED |
已启用自动备份配置。 |
方法 |
|
---|---|
|
备份 Redis 集群。 |
|
根据指定的属性创建 Redis 集群。 |
|
删除特定的 Redis 集群。 |
|
获取特定 Redis 集群的详细信息。 |
|
获取 Redis 集群的证书授权机构信息详情。 |
|
列出项目在指定位置(区域)或所有位置拥有的所有 Redis 集群。 |
|
更新特定 Redis 集群的元数据和配置。 |
|
重新安排即将进行的维护事件。 |