REST Resource: projects.locations.instances

リソース: インスタンス

Memorystore インスタンス。

JSON 表現 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "state": enum (State),
  "stateInfo": {
    object (StateInfo)
  },
  "uid": string,
  "authorizationMode": enum (AuthorizationMode),
  "transitEncryptionMode": enum (TransitEncryptionMode),
  "shardCount": integer,
  "discoveryEndpoints": [
    {
      object (DiscoveryEndpoint)
    }
  ],
  "nodeType": enum (NodeType),
  "persistenceConfig": {
    object (PersistenceConfig)
  },
  "engineVersion": string,
  "engineConfigs": {
    string: string,
    ...
  },
  "nodeConfig": {
    object (NodeConfig)
  },
  "zoneDistributionConfig": {
    object (ZoneDistributionConfig)
  },
  "pscAutoConnections": [
    {
      object (PscAutoConnection)
    }
  ],
  "replicaCount": integer,
  "deletionProtectionEnabled": boolean
}
フィールド
name

string

ID。インスタンスの一意の名前。形式: projects/{project}/locations/{location}/instances/{instance}

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"。
labels

map (key: string, value: string)

省略可。ユーザー指定のメタデータを表すラベル。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
state

enum (State)

出力専用。インスタンスの現在の状態。
stateInfo

object (StateInfo)

出力専用。インスタンスの状態に関する追加情報。
uid

string

出力専用。システムによって割り当てられたインスタンスの固有識別子。
authorizationMode

enum (AuthorizationMode)

省略可。変更不可。インスタンスの認可モード。
transitEncryptionMode

enum (TransitEncryptionMode)

省略可。変更不可。インスタンスの転送中の暗号化モード。
shardCount

integer

必須。インスタンスのシャードの数。
discoveryEndpoints[]

object (DiscoveryEndpoint)

出力専用。クライアントがインスタンスに接続できるエンドポイント。現時点では、検出エンドポイントは 1 つだけサポートされています。
nodeType

enum (NodeType)

省略可。変更不可。インスタンスの個々のノードのマシンタイプ。
persistenceConfig

object (PersistenceConfig)

省略可。インスタンスの永続性構成。
engineVersion

string

省略可。変更不可。インスタンスのエンジン バージョン。
engineConfigs

map (key: string, value: string)

省略可。ユーザー指定のインスタンスのエンジン構成。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
nodeConfig

object (NodeConfig)

出力専用。インスタンスの個々のノードの構成。
zoneDistributionConfig

object (ZoneDistributionConfig)

省略可。変更不可。ノードの割り当て用のインスタンスのゾーン分散構成。
pscAutoConnections[]

object (PscAutoConnection)

必須。変更不可。自動作成された PSC 接続のユーザー入力とリソースの詳細。
replicaCount

integer

省略可。シャードあたりのレプリカノードの数。省略した場合、デフォルトは 0 レプリカです。
deletionProtectionEnabled

boolean

省略可。true に設定すると、インスタンスの削除は失敗します。

状態

インスタンスが取り得る状態。

列挙型
STATE_UNSPECIFIED 未設定。
CREATING インスタンスを作成しています。
ACTIVE インスタンスが作成され、使用できる状態になりました。
UPDATING インスタンスを更新しています。
DELETING インスタンスを削除しています。

StateInfo

インスタンスの状態に関する追加情報。

JSON 表現 
{

  // Union field info can be only one of the following:
  "updateInfo": {
    object (UpdateInfo)
  }
  // End of list of possible types for union field info.
}
フィールド

共用体フィールド info。

info は次のいずれかになります。
updateInfo

object (UpdateInfo)

出力専用。インスタンスの状態が UPDATING の場合、進行中の更新について説明します。

UpdateInfo

UPDATING 状態のインスタンスに関する情報を表します。

JSON 表現 
{
  "targetShardCount": integer,
  "targetReplicaCount": integer
}
フィールド
targetShardCount

integer

出力専用。インスタンスのターゲット シャード数。
targetReplicaCount

integer

出力専用。インスタンスのシャードあたりのレプリカノードのターゲット数。

AuthorizationMode

インスタンスで使用できる認可モード。

列挙型
AUTHORIZATION_MODE_UNSPECIFIED 未設定。
AUTH_DISABLED 認可が無効になっています。
IAM_AUTH IAM 基本認証。

TransitEncryptionMode

インスタンスで使用できる転送中の暗号化モード。

列挙型
TRANSIT_ENCRYPTION_MODE_UNSPECIFIED 未設定。
TRANSIT_ENCRYPTION_DISABLED 転送中の暗号化が無効になっています。
SERVER_AUTHENTICATION 転送中の暗号化には、サーバー管理の暗号化が使用されます。

DiscoveryEndpoint

クライアントがインスタンスに接続するためのエンドポイントを表します。

JSON 表現 
{
  "address": string,
  "port": integer,
  "network": string
}
フィールド
address

string

出力専用。クライアントが接続する、公開されたエンドポイントの IP アドレス。
port

integer

出力専用。公開されているエンドポイントのポート番号。
network

string

出力専用。検出エンドポイントの IP アドレスが予約されるネットワーク（形式は projects/{networkProject}/global/networks/{network_id}）。

NodeType

インスタンスで使用できるノードタイプ。詳細については、https://cloud.google.com/memorystore/docs/valkey/instance-node-specification をご覧ください。

列挙型
NODE_TYPE_UNSPECIFIED 未設定。
SHARED_CORE_NANO 共有コア nano。
HIGHMEM_MEDIUM 中サイズのハイメモリ。
HIGHMEM_XLARGE ハイメモリ特大。
STANDARD_SMALL スタンダード小。

PersistenceConfig

インスタンスの永続性構成を表します。

JSON 表現 
{
  "mode": enum (PersistenceMode),
  "rdbConfig": {
    object (RDBConfig)
  },
  "aofConfig": {
    object (AOFConfig)
  }
}
フィールド
mode

enum (PersistenceMode)

省略可。現在の永続性モード。
rdbConfig

object (RDBConfig)

省略可。RDB 構成。モードが RDB でない場合、このフィールドは無視されます。
aofConfig

object (AOFConfig)

省略可。AOF 構成。モードが AOF でない場合、このフィールドは無視されます。

PersistenceMode

使用可能な永続性モード。

列挙型
PERSISTENCE_MODE_UNSPECIFIED 未設定。
DISABLED 永続性が無効になり、スナップショット データはすべて削除されます。
RDB RDB ベースの永続性が有効になっています。
AOF AOF ベースの永続性が有効になっています。

RDBConfig

RDB ベースの永続性の構成。

JSON 表現 
{
  "rdbSnapshotPeriod": enum (SnapshotPeriod),
  "rdbSnapshotStartTime": string
}
フィールド
rdbSnapshotPeriod

enum (SnapshotPeriod)

省略可。RDB スナップショット間の期間。
rdbSnapshotStartTime

string (Timestamp format)

省略可。最初にスナップショットが試行された時刻（または試行される予定の時刻）、および将来スナップショットが調整される時刻。指定しない場合は、現在の時刻が使用されます。

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

SnapshotPeriod

使用可能なスナップショット期間。

列挙型
SNAPSHOT_PERIOD_UNSPECIFIED 未設定。
ONE_HOUR 1 時間。
SIX_HOURS 6 時間。
TWELVE_HOURS 12 時間。
TWENTY_FOUR_HOURS 24 時間。

AOFConfig

AOF ベースの永続性の構成。

JSON 表現 
{
  "appendFsync": enum (AppendFsync)
}
フィールド
appendFsync

enum (AppendFsync)

省略可。fsync モード。

AppendFsync

使用可能な fsync モード。

列挙型
APPEND_FSYNC_UNSPECIFIED 未設定。 デフォルト: EVERY_SEC
NEVER fsync は実行されません。通常、Linux ではこの構成で 30 秒ごとにデータがフラッシュされますが、カーネルの正確なチューニングによって異なります。
EVERY_SEC 1 秒ごとに fsync が実行されます。障害が発生すると、1 秒分のデータが失われる可能性があります。
ALWAYS 新しいコマンドが AOF に追加されるたびに fsync を実行します。パフォーマンスを犠牲にすることなく、最適なデータ損失保護を実現します。

NodeConfig

インスタンスのノードの構成を表します。

JSON 表現 
{
  "sizeGb": number
}
フィールド
sizeGb

number

出力専用。ノードのメモリサイズ（GB）。

ZoneDistributionConfig

インスタンス リソースの割り当て用のゾーン分散構成。

JSON 表現 
{
  "zone": string,
  "mode": enum (ZoneDistributionMode)
}
フィールド
zone

string

省略可。SINGLE_ZONE モードですべてのリソースが割り振られるゾーンを定義します。MULTI_ZONE モードでは無視されます。
mode

enum (ZoneDistributionMode)

省略可。現在のゾーン分散モード。デフォルトは MULTI_ZONE です。

ZoneDistributionMode

使用可能なゾーン分散モード。

列挙型
ZONE_DISTRIBUTION_MODE_UNSPECIFIED 未設定。デフォルト: MULTI_ZONE
MULTI_ZONE リージョン内でランダムに選択された 3 つのゾーンにリソースを分散します。
SINGLE_ZONE 単一のゾーンにリソースをプロビジョニングします。ゾーン フィールドを指定する必要があります。

PscAutoConnection

PSC 接続のコンシューマー リソースの詳細。

JSON 表現 
{
  "pscConnectionId": string,
  "ipAddress": string,
  "forwardingRule": string,
  "projectId": string,
  "network": string
}
フィールド
pscConnectionId

string

出力専用。サービス アタッチメントに接続されている転送ルールの PSC 接続 ID。
ipAddress

string

出力専用。PSC 転送ルール用にコンシューマー ネットワークに割り当てられている IP。
forwardingRule

string

出力専用。コンシューマー側の転送ルールの URI。形式: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
projectId

string

必須。転送ルールが作成されるコンシューマーの projectId。
network

string

必須。IP アドレスが存在するコンシューマー ネットワーク。形式: projects/{projectId}/global/networks/{network_id}

メソッド

create

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

delete

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

get

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

getCertificateAuthority

 インスタンスの認証局の詳細を取得します。

list

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

patch

 単一インスタンスのパラメータを更新します。