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,
  "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)

資源標籤，用於代表使用者提供的中繼資料。詳情請參閱雲端標籤說明文件：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 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

僅供輸出。更新執行個體的時間。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如："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 的端點。
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)
  },
  "memcacheVersion": enum (MemcacheVersion),
  "memcacheFullVersion": string
}
欄位
nodeId

string

僅供輸出。Memcached 節點的 ID。節點 ID 不包含專案或位置，例如 Memcached 執行個體名稱。
zone

string

僅供輸出。Memcached 節點的位置 (GCP 區域)。
state

enum (State)

僅供輸出。Memcached 節點的目前狀態。
host

string

僅供輸出。用戶端用來連線至這個節點上的 Memcached 伺服器的主機名稱或 IP 位址。
port

integer

僅供輸出。這個節點上的 Memcached 伺服器連接埠號碼。
parameters

object (MemcacheParameters)

目前套用至節點的使用者定義參數。
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 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

僅供輸出。政策更新時間。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
description

string

說明這項政策的用途。如果長度超過 512，Create/Update 方法會傳回 INVALID_ARGUMENT。
weeklyMaintenanceWindow[]

object (WeeklyMaintenanceWindow)

這是必要旗標，套用至這項政策涵蓋的資源的維護期間。至少 1 個。在目前版本中，weekly_maintenance_windows 的數量上限為 1。

WeeklyMaintenanceWindow

指定每週作業的時間範圍。

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

enum (DayOfWeek)

這是必要旗標，允許定義在特定星期幾執行的排程。
startTime

object (TimeOfDay)

這是必要旗標，時段的開始時間 (世界標準時間)。
duration

string (Duration format)

這是必要旗標，時間範圍的持續時間。

以秒為單位的時間長度，最多可有 9 個小數位數，結尾為「s」，例如："3.5s"。

MaintenanceSchedule

近期維護作業時間表。

JSON 表示法 
{
  "startTime": string,
  "endTime": string,
  "scheduleDeadlineTime": string
}
欄位
startTime

string (Timestamp format)

僅供輸出。這個執行個體即將進行的排定維護作業開始時間。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
endTime

string (Timestamp format)

僅供輸出。這個執行個體即將進行的排定維護作業結束時間。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
scheduleDeadlineTime

string (Timestamp format)

僅供輸出。維護作業的開始時間不得超過這個期限，包括重新排程。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

方法

applyParameters

 ApplyParameters 會重新啟動一組指定節點，以便將這些節點更新為 Memcached 執行個體的目前參數組合。

create

 在指定位置建立新執行個體。

delete

 刪除單一執行個體。

get

 取得單一執行個體的詳細資料。

list

 列出指定位置的執行個體。

patch

 更新指定專案和位置中的現有執行個體。

rescheduleMaintenance

 重新排定即將進行的維護事件。

updateParameters

 更新現有執行個體的已定義 Memcached 參數。

upgrade

 將 Memcache 執行個體升級至要求中指定的新版 Memcached 引擎。