REST リソース: projects.locations.instances

リソース: インスタンス

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
}
フィールド
name

string

必須。このスコープ内のリソースの一意の名前（projects/{project_id}/locations/{locationId}/instances/{instanceId} 形式を使用するプロジェクトとロケーションを含む）

注: Memcached インスタンスはリージョン レベルで管理され、アドレス指定されるため、locationId の部分は GCP リージョンを指します。ただし、インスタンス内の 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」形式のタイムスタンプ。精度はナノ秒。例: "2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

出力のみ。インスタンスが更新された時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒。例: "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

出力のみ。ディスカバリ API のエンドポイント

NodeConfig

Memcached ノードの構成。

JSON 表現 

{
  "cpuCount": integer,
  "memorySizeMb": integer
}
フィールド
cpuCount

integer

必須。Memcached ノードあたりの CPU 数。
memorySizeMb

integer

必須。Memcached ノードごとのメモリサイズ（MiB 単位）。

MemcacheVersion

サービスでサポートされている Memcached バージョン。

列挙型
MEMCACHE_VERSION_UNSPECIFIED
MEMCACHE_1_5 Memcached 1.5 バージョン。

MemcacheParameters

JSON 表現 

{
  "id": string,
  "params": {
    string: string,
    ...
  }
}
フィールド
id

string

出力のみ。このパラメータ セットに関連付けられた一意の 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)
  }
}
フィールド
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)

現在、ノードに適用されているユーザー定義のパラメータ。

状態

Memcached ノードのさまざまな状態。

列挙型
STATE_UNSPECIFIED ノードの状態が設定されていません。
CREATING ノードを作成しています。
READY ノードが作成され、使用できる状態になりました。
DELETING ノードを削除しています。
UPDATING ノードを更新しています。

状態

Memcached インスタンスのさまざまな状態。

列挙型
STATE_UNSPECIFIED ステータスが設定されていません
CREATING Memcached インスタンスを作成しています。
READY Memcached インスタンスが作成され、使用できる状態になりました。
DELETING Memcached インスタンスを削除しています。
PERFORMING_MAINTENANCE Memcached インスタンスは、データプレーンのロールアウトなど、メンテナンス中です。

InstanceMessage

JSON 表現 

{
  "code": enum (Code),
  "message": string
}
項目
code

enum (Code)

ユーザー向けの 1 種類のメッセージに対応するコード。
message

string

ユーザーに公開される memcached インスタンス上のメッセージ。

コード

列挙型
CODE_UNSPECIFIED メッセージ コードが設定されていません。
ZONE_DISTRIBUTION_UNBALANCED Memcached ノードは不均一に分散されます。

メソッド

applyParameters

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

create

 指定されたプロジェクトとロケーションで新しいインスタンスを作成します。

delete

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

get

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

getIamPolicy

 リソースのアクセス制御ポリシーを取得します。

list

 指定されたプロジェクトとロケーションでのインスタンスを一覧で表示します。

patch

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

setIamPolicy

 指定したリソースのアクセス制御ポリシーを設定します。

testIamPermissions

 呼び出し元が指定されたリソース上で持つ権限を返します。

updateParameters

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