REST Resource: projects.locations.instances

资源：实例

Memorystore for Memcached 实例

JSON 表示法 
{
  "name": string,
  "displayName": string,
  "labels": {
    string: string,
    ...
  },
  "authorizedNetwork": string,
  "zones": [
    string
  ],
  "nodeCount": integer,
  "nodeConfig": {
    object (NodeConfig)
  },
  "memcacheVersion": enum (MemcacheVersion),
  "parameters": {
    object (MemcacheParameters)
  },
  "memcacheNodes": [
    {
      object (Node)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "state": enum (State),
  "memcacheFullVersion": string,
  "instanceMessages": [
    {
      object (InstanceMessage)
    }
  ],
  "discoveryEndpoint": string,
  "updateAvailable": boolean,
  "maintenancePolicy": {
    object (MaintenancePolicy)
  },
  "maintenanceSchedule": {
    object (MaintenanceSchedule)
  },
  "reservedIpRangeId": [
    string
  ]
}
字段
name

string

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

注意：Memcached 实例在区域级别进行托管和处理，因此这里的 locationId 指的是 Google Cloud 区域；但是，用户可以选择应预配实例内 Memcached 节点的具体可用区。如需了解详情，请参阅 zones 字段。
displayName

string

用户为实例提供的名称，仅用于显示目的。不得超过 80 个字符。
labels

map (key: string, value: string)

用于表示用户提供的元数据的资源标签如需了解详情，请参阅有关标签的 Cloud 文档。https://cloud.google.com/compute/docs/labeling-resources

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
authorizedNetwork

string

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

string

应在其中预配 Memcached 节点的可用区。Memcached 节点将平均分布在这些可用区中。如果未提供，默认情况下，服务将在实例所在区域的所有可用区中创建节点。
nodeCount

integer

必需。Memcached 实例中的节点数。
nodeConfig

object (NodeConfig)

必需。Memcached 节点的配置。
memcacheVersion

enum (MemcacheVersion)

Memcached 软件的主要版本。如果未提供，将使用最新的支持版本。目前受支持的最新主要版本是 MEMCACHE_1_5。系统会根据支持的最新次要版本自动确定次要版本。
parameters

object (MemcacheParameters)

要应用到每个节点上 Memcached 进程的用户定义参数。
memcacheNodes[]

object (Node)

仅限输出。Memcached 节点列表。如需了解详情，请参阅 Node 消息。
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"。
state

enum (State)

仅限输出。此 Memcached 实例的状态。
memcacheFullVersion

string

仅供输出。在此实例上运行的完整版 Memcached 服务器。系统会根据输入 MemcacheVersion 自动确定实例的完整 Memcached 版本。完整版本格式为“memcached-1.5.16”。
instanceMessages[]

object (InstanceMessage)

消息列表，描述 Memcached 实例的当前状态。
discoveryEndpoint

string

仅限输出。Discovery API 的端点。
updateAvailable

boolean

仅限输出。如果有更新等待应用，则返回 true
maintenancePolicy

object (MaintenancePolicy)

实例的维护政策。如果未提供，则系统会根据 Memorystore 内部发布时间表执行维护事件。
maintenanceSchedule

object (MaintenanceSchedule)

仅限输出。已发布的维护时间表。
reservedIpRangeId[]

string

可选。包含与专用服务访问通道关联的已分配 IP 地址范围的 ID，例如与 IP 地址范围 10.0.0.0/29 关联的“test-default”。

NodeConfig

Memcached 节点的配置。

JSON 表示 
{
  "cpuCount": integer,
  "memorySizeMb": integer
}
字段
cpuCount

integer

必需。每个 Memcached 节点的 CPU 数量。
memorySizeMb

integer

必需。每个 Memcached 节点的内存大小（以 MiB 为单位）。

MemcacheVersion

我们的服务支持的 Memcached 版本。

枚举
MEMCACHE_VERSION_UNSPECIFIED 客户未指定 Memcache 版本
MEMCACHE_1_5 Memcached 1.5 版。
MEMCACHE_1_6_15 Memcached 1.6.15 版。

MemcacheParameters

JSON 表示 
{
  "id": string,
  "params": {
    string: string,
    ...
  }
}
字段
id

string

仅供输出。与这组参数相关联的唯一 ID。用户可以使用此 ID 来确定与实例关联的参数是否与与节点关联的参数不同。如果参数 ID 不一致，系统会告知用户可能需要执行操作才能在节点上应用参数。
params

map (key: string, value: string)

用户定义的一组参数，用于 Memcached 进程。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

节点

JSON 表示 
{
  "nodeId": string,
  "zone": string,
  "state": enum (State),
  "host": string,
  "port": integer,
  "parameters": {
    object (MemcacheParameters)
  },
  "updateAvailable": boolean,
  "memcacheVersion": enum (MemcacheVersion),
  "memcacheFullVersion": string
}
字段
nodeId

string

仅供输出。Memcached 节点的标识符。节点 ID 不包含项目或位置，例如 Memcached 实例名称。
zone

string

仅供输出。Memcached 节点的位置（GCP 可用区）。
state

enum (State)

仅供输出。Memcached 节点的当前状态。
host

string

仅供输出。客户端使用的 Memcached 节点主机名或 IP 地址，用于连接到此节点上的 Memcached 服务器。
port

integer

仅供输出。此节点上 Memcached 服务器的端口号。
parameters

object (MemcacheParameters)

当前应用于节点的用户定义参数。
updateAvailable

boolean

仅限输出。如果有更新等待应用，则返回 true
memcacheVersion

enum (MemcacheVersion)

仅限输出。此节点上运行的 Memcached 服务器的主要版本，例如 MEMCACHE_1_5
memcacheFullVersion

string

仅限输出。在此节点上运行的 Memcached 服务器的完整版本。例如- Memcached-1.5.16

州

Memcached 节点的不同状态。

枚举
STATE_UNSPECIFIED 未设置节点状态。
CREATING 正在创建节点。
READY 节点已创建完毕，随时可供使用。
DELETING 正在删除节点。
UPDATING 正在更新节点。

州

Memcached 实例的不同状态。

枚举
STATE_UNSPECIFIED 状态未设置。
CREATING 正在创建 Memcached 实例。
READY 已创建 Memcached 实例并可供使用。
UPDATING Memcached 实例正在更新配置，例如维护政策和时间表。
DELETING 正在删除 Memcached 实例。
PERFORMING_MAINTENANCE 正在维护 Memcached 实例，例如数据平面发布。
MEMCACHE_VERSION_UPGRADING Memcached 实例正在升级 Memcached 引擎版本。

InstanceMessage

JSON 表示 
{
  "code": enum (Code),
  "message": string
}
字段
code

enum (Code)

对应于一种面向用户的消息的代码。
message

string

Memcached 实例上向用户公开的消息。

代码

枚举
CODE_UNSPECIFIED 未设置消息代码。
ZONE_DISTRIBUTION_UNBALANCED Memcached 节点分布不均匀。

MaintenancePolicy

每个实例的维护政策。

JSON 表示法 
{
  "createTime": string,
  "updateTime": string,
  "description": string,
  "weeklyMaintenanceWindow": [
    {
      object (WeeklyMaintenanceWindow)
    }
  ]
}
字段
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"。
description

string

对此政策的适用情形的说明。如果长度超过 512，则创建/更新方法会返回 INVALID_ARGUMENT。
weeklyMaintenanceWindow[]

object (WeeklyMaintenanceWindow)

必需。应用于此政策涵盖的资源的维护时间。最小值为 1。对于当前版本，week_maintenance_windows 的最大数量应该为 1。

WeeklyMaintenanceWindow

为每周操作指定的时间范围。

JSON 表示法 
{
  "day": enum (DayOfWeek),
  "startTime": {
    object (TimeOfDay)
  },
  "duration": string
}
字段
day

enum (DayOfWeek)

必需。允许定义在一周中的特定几天运行的时间表。
startTime

object (TimeOfDay)

必需。时段的开始时间（世界协调时间）。
duration

string (Duration format)

必需。时间范围的时长。

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

MaintenanceSchedule

即将开始的维护时间表。

JSON 表示法 
{
  "startTime": string,
  "endTime": string,
  "scheduleDeadlineTime": string
}
字段
startTime

string (Timestamp format)

仅限输出。此实例的任何近期维护的开始时间。

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

string (Timestamp format)

仅限输出。此实例任何即将进行的计划维护的结束时间。

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

string (Timestamp format)

仅限输出。维护时间表的开始时间不得晚于此截止日期（包括重新安排）。

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

方法

applyParameters

 ApplyParameters 会重启一组指定节点，以将其更新为 Memcached 实例的当前参数集。

applySoftwareUpdate

 更新实例的所选节点上的软件。

create

 在给定位置创建新实例。

delete

 删除单个实例。

get

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

list

 列出给定位置中的实例。

patch

 更新给定项目和位置中的现有实例。

rescheduleMaintenance

 执行 RescheduleScheduling 动词的应用阶段。

updateParameters

 更新定义给现有实例的 Memcached 参数。

upgrade

 将 Memcache 实例升级到请求中指定的较新 Memcached 引擎版本。