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 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

出力専用。インスタンスが更新された時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "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 サーバーに接続するために使用する 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)

ユーザーに表示されるメッセージの 1 つのタイプに対応するコード。
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「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

出力専用。ポリシーが更新された時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "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)

必須。時間枠の開始時刻（UTC）。
duration

string (Duration format)

必須。時間枠の長さ。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。

MaintenanceSchedule

今後のメンテナンス スケジュール。

JSON 表現 
{
  "startTime": string,
  "endTime": string,
  "scheduleDeadlineTime": string
}
フィールド
startTime

string (Timestamp format)

出力専用。このインスタンスに対する次回の定期メンテナンスの開始時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
endTime

string (Timestamp format)

出力専用。このインスタンスに対する次回の定期メンテナンスの開始時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
scheduleDeadlineTime

string (Timestamp format)

出力専用。メンテナンス スケジュールの開始時間が超過できない期限（スケジュール変更を含む）。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

メソッド

applyParameters

 ApplyParameters は、指定されたノードセットを再起動して、Memcached インスタンスの現在のパラメータ セットに更新します。

create

 指定されたロケーションに新しいインスタンスを作成します。

delete

 1 つのインスタンスを削除します。

get

 1 つのインスタンスの詳細を取得します。

list

 特定のロケーションのインスタンスを一覧表示します。

patch

 指定されたプロジェクトとロケーションで既存のインスタンスを更新します。

rescheduleMaintenance

 今後のメンテナンス イベントのスケジュールを変更します。

updateParameters

 既存のインスタンスの定義済みの Memcached パラメータを更新します。

upgrade

 Memcache インスタンスを、リクエストで指定された新しい memcached エンジン バージョンにアップグレードします。