REST 资源：projects.locations.instances

资源：实例

Google Cloud Redis 实例。

JSON 表示法 

{
  "name": string,
  "displayName": string,
  "labels": {
    string: string,
    ...
  },
  "locationId": string,
  "alternativeLocationId": string,
  "redisVersion": string,
  "reservedIpRange": string,
  "host": string,
  "port": number,
  "currentLocationId": string,
  "createTime": string,
  "state": enum(State),
  "statusMessage": string,
  "redisConfigs": {
    string: string,
    ...
  },
  "tier": enum(Tier),
  "memorySizeGb": number,
  "authorizedNetwork": string,
  "persistenceIamIdentity": string
}
字段
name

string

必需。此范围内资源采用以下形式的非重复名称，包括项目和位置：projects/{projectId}/locations/{locationId}/instances/{instanceId}

注意：Redis 实例在区域级别进行托管和处理，因此这里的 locationId 指的是 GCP 区域；但是，用户可以选择应预配实例的具体地区（或者为跨地区实例选择地区集合）。如需了解详情，请参阅 [locationId] 和 [alternativeLocationId] 字段。
displayName

string

用户提供的任意且可选的实例名称。

labels

map (key: string, value: string)

用于表示用户提供的元数据的资源标签

包含 "key": value 对列表的对象。例如：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
locationId

string

可选。将在其中配置实例的地区。如果未提供，服务将为实例选择一个地区。对于 STANDARD_HA 层级，将跨两个地区创建实例以防止地区性故障。如果还提供了 [alternativeLocationId]，它必须不同于 [locationId]。

alternativeLocationId

string

可选。仅适用于 STANDARD_HA 层级，该层级通过将它配置在两个地区来防止实例出现地区性故障。如果已提供，则必须不同于 [locationId] 中提供的地区。

redisVersion

string

可选。Redis 软件的版本。如果未提供，将使用最新的支持版本。更新版本将升级/降级到新版本。目前，Redis 3.2 支持的值为 REDIS_3_2。

reservedIpRange

string

可选。为此实例保留的内部地址的 CIDR 范围。如果未提供，服务将选择未使用的 /29 块，例如 10.0.0.0/29 或 192.168.0.0/29。范围必须是唯一的，并且不与授权网络中的现有子网重叠。

host

string

仅限输出。客户端用于连接到服务的公开 Redis 端点的主机名或 IP 地址。

port

number

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

currentLocationId

string

仅限输出。放置 Redis 端点的当前地区。对于基本层级实例，它将始终与用户在创建时提供的 [locationId] 相同。对于标准层级实例，它可以是 [locationId] 或 [alternativeLocationId]，并且可以在故障转移事件后更改。

createTime

string (Timestamp format)

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

此时间戳采用 RFC3339 世界协调时间 (UTC)（即“祖鲁时”）格式，且精确到纳秒。例如："2014-10-02T15:01:23.045123456Z"。
state

enum(State)

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

statusMessage

string

仅限输出。有关此实例的当前状态的其他信息（如果有）。

redisConfigs

map (key: string, value: string)

可选。Redis 配置参数，请参考 http://redis.io/topics/config。目前仅支持以下参数：

  • maxmemory-policy
  • notify-keyspace-events

包含 "key": value 对列表的对象。例如：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
tier

enum(Tier)

必需。实例的服务层级。

memorySizeGb

number

必需。Redis 内存大小（以 GiB 为单位）。
authorizedNetwork

string

可选。实例接入的 Google Compute Engine 网络的全名。如果未指定，将使用 default 网络。

persistenceIamIdentity

string

仅限输出。导入/导出操作用于将数据传入/传出 GCS 的 IAM 身份。格式为 “serviceAccount：”。对于给定实例，该值可能会随时间而变化，因此应在每次导入/导出操作之前进行检查。

状态

表示 Redis 实例的不同状态。

枚举
STATE_UNSPECIFIED 未设置。
CREATING 正在创建 Redis 实例。
READY Redis 实例已创建并完全可用。
UPDATING 正在更新 Redis 实例配置。某些类型的更新可能会导致实例在更新进行的过程中不可用。
DELETING 正在删除 Redis 实例。
REPAIRING Redis 实例正在修复，可能无法使用。可以在 statusMessage 字段中找到详细信息。
MAINTENANCE 正在对此 Redis 实例进行维护。
IMPORTING Redis 实例正在导入数据（可用性可能会受到影响）。

层级

可供选择的服务层级

枚举
TIER_UNSPECIFIED 未设置。
BASIC 基本层级：独立实例
STANDARD_HA STANDARD_HA 层级：可用性高的主实例/副本实例

方法

create

 根据指定的层级和内存大小创建 Redis 实例。

delete

 删除特定 Redis 实例。

get

 获取特定 Redis 实例的详细信息。

list

 列出项目在指定位置（区域）或所有位置拥有的所有 Redis 实例。

patch

 更新特定 Redis 实例的元数据和配置。