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)
    }
  ],
  "replicaCount": integer,
  "deletionProtectionEnabled": boolean
}
字段
name

string

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

string (Timestamp format)

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

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

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

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
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[]

object (DiscoveryEndpoint)

仅限输出。客户端可以通过此端点连接到实例。目前仅支持一个发现端点。
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[]

object (PscAutoConnection)

必需。不可变。自动创建的 PSC 连接的用户输入和资源详细信息。
replicaCount

integer

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

boolean

可选。如果设置为 true，则删除实例将失败。

州

实例的可能状态。

枚举
STATE_UNSPECIFIED 未设置。
CREATING 正在创建实例。
ACTIVE 实例已创建完毕，可以使用。
UPDATING 正在更新实例。
DELETING 正在删除实例。

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)

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

UpdateInfo

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

JSON 表示法 
{
  "targetShardCount": integer,
  "targetReplicaCount": integer
}
字段
targetShardCount

integer

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

integer

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

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

string

仅限输出。公开的端点客户端所连接的 IP 地址。
port

integer

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

string

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

NodeType

实例的可能节点类型。如需了解详情，请参阅 https://cloud.google.com/memorystore/docs/valkey/instance-node-specification。

枚举
NODE_TYPE_UNSPECIFIED 未设置。
SHARED_CORE_NANO 共享核心 nano。
HIGHMEM_MEDIUM 高内存中等。
HIGHMEM_XLARGE 内存用量过高（极大）。
STANDARD_SMALL 标准小型。

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)

可选。首次尝试/将尝试创建快照的时间，未来的快照将与此时间保持一致。如果未提供此时间，将使用当前时间。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

SnapshotPeriod

可能的快照期。

枚举
SNAPSHOT_PERIOD_UNSPECIFIED 未设置。
ONE_HOUR 一小时。
SIX_HOURS 六小时。
TWELVE_HOURS 十二小时。
TWENTY_FOUR_HOURS 二十四小时

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,
  "mode": enum (ZoneDistributionMode)
}
字段
zone

string

可选。定义将使用 SINGLE_ZONE 模式分配所有资源的可用区。对于 MULTI_ZONE 模式，系统会忽略此参数。
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
}
字段
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_id}。

方法

create

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

delete

 删除单个实例。

get

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

getCertificateAuthority

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

list

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

patch

 更新单个实例的参数。