このページは Cloud Translation API によって翻訳されました。

REST Resource: projects.locations.clusters

リソース: クラスタ
- JSON 表現
GcsBackupSource
- JSON 表現
ManagedBackupSource
- JSON 表現
都道府県
AuthorizationMode
TransitEncryptionMode
PscConfig
- JSON 表現
DiscoveryEndpoint
- JSON 表現
PscConnection
- JSON 表現
PscConnectionStatus
ConnectionType
StateInfo
- JSON 表現
UpdateInfo
- JSON 表現
ClusterPersistenceConfig
- JSON 表現
PersistenceMode
RDBConfig
- JSON 表現
SnapshotPeriod
AOFConfig
- JSON 表現
AppendFsync
ZoneDistributionConfig
- JSON 表現
ZoneDistributionMode
CrossClusterReplicationConfig
- JSON 表現
ClusterRole
RemoteCluster
- JSON 表現
メンバーシップ
- JSON 表現
ClusterMaintenancePolicy
- JSON 表現
ClusterWeeklyMaintenanceWindow
- JSON 表現
ClusterMaintenanceSchedule
- JSON 表現
PscServiceAttachment
- JSON 表現
ClusterEndpoint
- JSON 表現
ConnectionDetail
- JSON 表現
PscAutoConnection
- JSON 表現
AutomatedBackupConfig
- JSON 表現
FixedFrequencySchedule
- JSON 表現
AutomatedBackupMode
メソッド

リソース: Cluster

クラスタインスタンス。

JSON 表現

JSON 表現
{ "name": string, "createTime": string, "state": enum (`State`), "uid": string, "authorizationMode": enum (`AuthorizationMode`), "transitEncryptionMode": enum (`TransitEncryptionMode`), "pscConfigs": [ { object (`PscConfig`) } ], "discoveryEndpoints": [ { object (`DiscoveryEndpoint`) } ], "pscConnections": [ { object (`PscConnection`) } ], "stateInfo": { object (`StateInfo`) }, "nodeType": enum (`NodeType`), "persistenceConfig": { object (`ClusterPersistenceConfig`) }, "redisConfigs": { string: string, ... }, "zoneDistributionConfig": { object (`ZoneDistributionConfig`) }, "crossClusterReplicationConfig": { object (`CrossClusterReplicationConfig`) }, "pscServiceAttachments": [ { object (`PscServiceAttachment`) } ], "clusterEndpoints": [ { object (`ClusterEndpoint`) } ], "automatedBackupConfig": { object (`AutomatedBackupConfig`) }, "encryptionInfo": { object (`EncryptionInfo`) }, "allowFewerZonesDeployment": boolean, // Union field `import_sources` can be only one of the following: "gcsSource": { object (`GcsBackupSource`) }, "managedBackupSource": { object (`ManagedBackupSource`) } // End of list of possible types for union field `import_sources`. "replicaCount": integer, "sizeGb": integer, "shardCount": integer, "preciseSizeGb": number, "deletionProtectionEnabled": boolean, "maintenancePolicy": { object (`ClusterMaintenancePolicy`) }, "maintenanceSchedule": { object (`ClusterMaintenanceSchedule`) }, "simulateMaintenanceEvent": boolean, "backupCollection": string, "kmsKey": string, "ondemandMaintenance": boolean, "asyncClusterEndpointsDeletionEnabled": boolean }

{
  "name": string,
  "createTime": string,
  "state": enum (State),
  "uid": string,
  "authorizationMode": enum (AuthorizationMode),
  "transitEncryptionMode": enum (TransitEncryptionMode),
  "pscConfigs": [
    {
      object (PscConfig)
    }
  ],
  "discoveryEndpoints": [
    {
      object (DiscoveryEndpoint)
    }
  ],
  "pscConnections": [
    {
      object (PscConnection)
    }
  ],
  "stateInfo": {
    object (StateInfo)
  },
  "nodeType": enum (NodeType),
  "persistenceConfig": {
    object (ClusterPersistenceConfig)
  },
  "redisConfigs": {
    string: string,
    ...
  },
  "zoneDistributionConfig": {
    object (ZoneDistributionConfig)
  },
  "crossClusterReplicationConfig": {
    object (CrossClusterReplicationConfig)
  },
  "pscServiceAttachments": [
    {
      object (PscServiceAttachment)
    }
  ],
  "clusterEndpoints": [
    {
      object (ClusterEndpoint)
    }
  ],
  "automatedBackupConfig": {
    object (AutomatedBackupConfig)
  },
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "allowFewerZonesDeployment": boolean,

  // Union field import_sources can be only one of the following:
  "gcsSource": {
    object (GcsBackupSource)
  },
  "managedBackupSource": {
    object (ManagedBackupSource)
  }
  // End of list of possible types for union field import_sources.
  "replicaCount": integer,
  "sizeGb": integer,
  "shardCount": integer,
  "preciseSizeGb": number,
  "deletionProtectionEnabled": boolean,
  "maintenancePolicy": {
    object (ClusterMaintenancePolicy)
  },
  "maintenanceSchedule": {
    object (ClusterMaintenanceSchedule)
  },
  "simulateMaintenanceEvent": boolean,
  "backupCollection": string,
  "kmsKey": string,
  "ondemandMaintenance": boolean,
  "asyncClusterEndpointsDeletionEnabled": boolean
}

フィールド
`name`	`string` 必須。ID。このスコープ内のリソースの一意の名前（`projects/{projectId}/locations/{locationId}/clusters/{clusterId}` 形式を使用するプロジェクトとロケーションを含む）
`createTime`	`string (Timestamp format)` 出力専用。クラスタ作成リクエストに関連付けられたタイムスタンプ。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: `"2014-10-02T15:01:23Z"`、`"2014-10-02T15:01:23.045123456Z"`、`"2014-10-02T15:01:23+05:30"`。
`state`	`enum (State)` 出力専用。このクラスタの現在の状態。CREATING、READY、UPDATING、DELETING、SUSPENDED のいずれかになります。
`uid`	`string` 出力専用。システムによって割り当てられたクラスタの固有識別子。
`authorizationMode`	`enum (AuthorizationMode)` 省略可。Redis クラスタの認可モード。指定しない場合、クラスタの認証機能は無効になります。
`transitEncryptionMode`	`enum (TransitEncryptionMode)` 省略可。Redis クラスタの転送中の暗号化。指定しない場合、クラスタの暗号化は無効になります。
`pscConfigs[]`	`object (PscConfig)` 省略可。各 PscConfig は、Private Service Connect Automation を介してクライアントアクセス用に IP がクラスタに割り当てられるコンシューマーネットワークを構成します。現在、サポートされている PscConfig は 1 つのみです。
`discoveryEndpoints[]`	`object (DiscoveryEndpoint)` 出力専用。Redis クライアントがクラスタに接続するために、指定された各ネットワークに作成されたエンドポイント。現時点では、検出エンドポイントは 1 つだけサポートされています。
`pscConnections[]`	`object (PscConnection)` 出力専用。サービス接続の自動化によって自動作成された PSC 接続のリスト。
`stateInfo`	`object (StateInfo)` 出力専用。クラスタの現在の状態に関する追加情報。
`nodeType`	`enum (NodeType)` 省略可。クラスタ内の Redis ノードのタイプ。NodeType は、Redis ノードの基盤となるマシンタイプを決定します。
`persistenceConfig`	`object (ClusterPersistenceConfig)` 省略可。クラスタの永続性構成（RDB、AOF）。
`redisConfigs`	`map (key: string, value: string)` 省略可。変更可能な Redis 構成に対するお客様のオーバーライドの Key-Value ペア `"key": value` ペアのリストを含むオブジェクト。例: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`
`zoneDistributionConfig`	`object (ZoneDistributionConfig)` 省略可。この構成は、お客様がリージョン内でクラスタリソースをどのように分散したいかを判断するために使用されます。
`crossClusterReplicationConfig`	`object (CrossClusterReplicationConfig)` 省略可。クロスクラスタレプリケーション構成。
`pscServiceAttachments[]`	`object (PscServiceAttachment)` 出力専用。Psc 接続を構成するためのサービスアタッチメントの詳細
`clusterEndpoints[]`	`object (ClusterEndpoint)` 省略可。クラスタエンドポイントのリスト。
`automatedBackupConfig`	`object (AutomatedBackupConfig)` 省略可。クラスタの自動バックアップ構成。
`encryptionInfo`	`object (EncryptionInfo)` 出力専用。クラスタの保存データの暗号化情報。
`allowFewerZonesDeployment`	`boolean` 省略可。変更不可。3 つ未満のゾーンにマルチゾーンクラスタをデプロイしてもよいかどうかを指定できます。設定後、クラスタの作成中にゾーンで停止が発生した場合、クラスタは 2 つのゾーンにのみデプロイされ、ライフサイクル全体で 2 つのゾーン内に留まります。
共用体フィールド `import_sources`。インポート元のソース。`import_sources` は次のいずれかになります。
`gcsSource`	`object (GcsBackupSource)` 省略可。Cloud Storage バケットに保存されたバックアップ。Cloud Storage バケットは、クラスタと同じリージョンに存在する必要があります。指定された Cloud Storage オブジェクトからインポートするには、読み取り権限が必要です。
`managedBackupSource`	`object (ManagedBackupSource)` 省略可。Memorystore サービスによって生成および管理されるバックアップ。
`replicaCount`	`integer` 省略可。シャードあたりのレプリカノードの数。
`sizeGb`	`integer` 出力専用。クラスタ全体の Redis メモリサイズ（GB 単位）。次の整数に切り上げられます。
`shardCount`	`integer` 省略可。Redis クラスタのシャード数。
`preciseSizeGb`	`number` 出力専用。クラスタ全体の Redis メモリサイズの正確な値（GB 単位）。
`deletionProtectionEnabled`	`boolean` 省略可。値が true に設定されている場合、削除オペレーションは失敗します。
`maintenancePolicy`	`object (ClusterMaintenancePolicy)` 省略可。ClusterMaintenancePolicy は、更新を許可または拒否するタイミングを決定します。
`maintenanceSchedule`	`object (ClusterMaintenanceSchedule)` 出力専用。ClusterMaintenanceSchedule 出力専用。公開されたメンテナンススケジュール。
`simulateMaintenanceEvent`	`boolean` 省略可。入力専用。メンテナンスイベントをシミュレートします。
`backupCollection`	`string` 省略可。出力専用。バックアップコレクションの完全なリソース名。例: projects/{project}/locations/{location}/backupCollections/{collection}
`kmsKey`	`string` 省略可。クラスタの保存データを暗号化するために使用される KMS 鍵。
`ondemandMaintenance (deprecated)`	`boolean` この項目は非推奨です。省略可。入力専用。クラスタのオンデマンドメンテナンス。このフィールドは、クラスタでオンデマンドの重要な更新をトリガーするために使用できます。
`asyncClusterEndpointsDeletionEnabled`	`boolean` 省略可。true の場合、お客様が作成して登録したクラスタエンドポイントを非同期で削除できます。つまり、このようなクラスタエンドポイントは、クラスタエンドポイントの転送ルールが削除される前に登録解除できます。

GcsBackupSource

Cloud Storage バケットに保存されたバックアップ。Cloud Storage バケットは、クラスタと同じリージョンに存在する必要があります。

JSON 表現
{ "uris": [ string ] }

フィールド

フィールド
`uris[]`	`string` 省略可。インポートする Cloud Storage オブジェクトの URI。例: gs://bucket1/object1、gs://bucket2/folder2/object2

uris[]

string

省略可。インポートする Cloud Storage オブジェクトの URI。例: gs://bucket1/object1、gs://bucket2/folder2/object2

ManagedBackupSource

Memorystore によって生成および管理されるバックアップ。

JSON 表現
{ "backup": string }

フィールド

フィールド
`backup`	`string` 省略可。例: //redis.googleapis.com/projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup} バックアップ名の短縮版（接頭辞なし）もサポートされています（projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backupId} など）。この場合、バックアップは redis.googleapis.com の下にあると想定されます。

backup

string

省略可。例: //redis.googleapis.com/projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup} バックアップ名の短縮版（接頭辞なし）もサポートされています（projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backupId} など）。この場合、バックアップは redis.googleapis.com の下にあると想定されます。

状態

Redis クラスタのさまざまな状態を表します。

列挙型
`STATE_UNSPECIFIED`	未設定。
`CREATING`	Redis クラスタを作成しています。
`ACTIVE`	Redis クラスタが作成され、完全に使用可能になりました。
`UPDATING`	Redis クラスタ構成を更新中です。
`DELETING`	Redis クラスタを削除しています。

AuthorizationMode

Redis クラスタで使用可能な認可モード。

列挙型
`AUTH_MODE_UNSPECIFIED`	未設定。
`AUTH_MODE_IAM_AUTH`	IAM 基本認証モード
`AUTH_MODE_DISABLED`	認可が無効モード

TransitEncryptionMode

転送中の暗号化に使用できるモード。

列挙型
`TRANSIT_ENCRYPTION_MODE_UNSPECIFIED`	転送中の暗号化が設定されていません。
`TRANSIT_ENCRYPTION_MODE_DISABLED`	転送中の暗号化が無効になっています。
`TRANSIT_ENCRYPTION_MODE_SERVER_AUTHENTICATION`	転送中の暗号化にはサーバー管理の暗号化を使用します。

PscConfig

JSON 表現
{ "network": string }

フィールド

フィールド
`network`	`string` 必須。検出エンドポイントの IP アドレスが予約されるネットワーク（形式は projects/{networkProject}/global/networks/{network_id}）。

network

string

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

DiscoveryEndpoint

Redis クライアントがクラスタに接続するための、各ネットワークのエンドポイント。

JSON 表現
{ "address": string, "port": integer, "pscConfig": { object (`PscConfig`) } }

フィールド

フィールド
`address`	`string` 出力専用。クライアントがサービスに接続するために使用する、公開された Redis エンドポイントのアドレス。アドレスは IP またはホスト名のいずれかになります。
`port`	`integer` 出力専用。公開されている Redis エンドポイントのポート番号。
`pscConfig`	`object (PscConfig)` 出力専用。エンドポイントが作成され、アクセスされる場所に関するお客様の構成。

address

string

出力専用。クライアントがサービスに接続するために使用する、公開された Redis エンドポイントのアドレス。アドレスは IP またはホスト名のいずれかになります。

port

integer

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

pscConfig

object (PscConfig)

出力専用。エンドポイントが作成され、アクセスされる場所に関するお客様の構成。

PscConnection

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

JSON 表現

JSON 表現
{ "pscConnectionId": string, "address": string, "forwardingRule": string, "projectId": string, "network": string, "serviceAttachment": string, "pscConnectionStatus": enum (`PscConnectionStatus`), "connectionType": enum (`ConnectionType`), // Union field `ports` can be only one of the following: "port": integer // End of list of possible types for union field `ports`. }

{
  "pscConnectionId": string,
  "address": string,
  "forwardingRule": string,
  "projectId": string,
  "network": string,
  "serviceAttachment": string,
  "pscConnectionStatus": enum (PscConnectionStatus),
  "connectionType": enum (ConnectionType),

  // Union field ports can be only one of the following:
  "port": integer
  // End of list of possible types for union field ports.
}

フィールド
`pscConnectionId`	`string` 必須。サービスアタッチメントに接続されている転送ルールの PSC 接続 ID。
`address`	`string` 必須。PSC 転送ルール用にコンシューマーネットワークに割り当てられている IP。
`forwardingRule`	`string` 必須。コンシューマー側の転送ルールの URI。例: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}。
`projectId`	`string` 省略可。転送ルールが作成されるコンシューマープロジェクトのプロジェクト ID。
`network`	`string` 必須。IP アドレスが存在するコンシューマーネットワーク。形式: projects/{projectId}/global/networks/{network_id}
`serviceAttachment`	`string` 必須。PSC 接続のターゲットであるサービスアタッチメント。形式は projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id} です。
`pscConnectionStatus`	`enum (PscConnectionStatus)` 出力専用。PSC 接続のステータス。この値は定期的に更新されます。PSC 接続の最新のステータスを取得するには、https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details をご覧ください。
`connectionType`	`enum (ConnectionType)` 出力専用。PSC 接続のタイプ。
共用体フィールド `ports`。公開されている検出エンドポイントのポート番号。`ports` は次のいずれかになります。
`port`	`integer` 出力のみ。ポートは、プライマリ/リーダーまたはディスカバリエンドポイントに対してのみ設定されます。

PscConnectionStatus

PSC 接続のステータス。

列挙型
`PSC_CONNECTION_STATUS_UNSPECIFIED`	PSC 接続のステータスが指定されていません。
`PSC_CONNECTION_STATUS_ACTIVE`	接続がアクティブである
`PSC_CONNECTION_STATUS_NOT_FOUND`	接続が見つかりません

ConnectionType

クラスタアクセスを目的とした PSC 接続のタイプ。

列挙型
`CONNECTION_TYPE_UNSPECIFIED`	クラスタエンドポイントのタイプが設定されていない
`CONNECTION_TYPE_DISCOVERY`	クラスタトポロジの検出に使用されるクラスタエンドポイント。
`CONNECTION_TYPE_PRIMARY`	プライマリにアクセスするためのプライマリエンドポイントとして使用されるクラスタエンドポイント。
`CONNECTION_TYPE_READER`	レプリカへのアクセスにリーダーエンドポイントとして使用されるクラスタエンドポイント。

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 の場合に、クラスタの進行中の更新について説明します。

共用体フィールド info。

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

updateInfo

object (UpdateInfo)

クラスタの状態が UPDATING の場合に、クラスタの進行中の更新について説明します。

UpdateInfo

更新中のクラスタに関する情報を表します。

JSON 表現
{ "targetShardCount": integer, "targetReplicaCount": integer, "targetNodeType": enum (`NodeType`) }

フィールド

フィールド
`targetShardCount`	`integer` Redis クラスタのシャードの目標数
`targetReplicaCount`	`integer` シャードあたりのレプリカノードの目標数。
`targetNodeType`	`enum (NodeType)` Redis クラスタのターゲットノードタイプ。

targetShardCount

integer

Redis クラスタのシャードの目標数

targetReplicaCount

integer

シャードあたりのレプリカノードの目標数。

targetNodeType

enum (NodeType)

Redis クラスタのターゲットノードタイプ。

ClusterPersistenceConfig

永続性機能の構成。

JSON 表現
{ "mode": enum (`PersistenceMode`), "rdbConfig": { object (`RDBConfig`) }, "aofConfig": { object (`AOFConfig`) } }

フィールド

フィールド
`mode`	`enum (PersistenceMode)` 省略可。永続性モード。
`rdbConfig`	`object (RDBConfig)` 省略可。RDB 構成。モードが RDB でない場合、このフィールドは無視されます。
`aofConfig`	`object (AOFConfig)` 省略可。AOF 構成。モードが AOF でない場合、このフィールドは無視されます。

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)` 省略可。最初にスナップショットが試行された時刻（または試行される予定の時刻）、および将来スナップショットが調整される時刻。指定しない場合は、現在の時刻が使用されます。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: `"2014-10-02T15:01:23Z"`、`"2014-10-02T15:01:23.045123456Z"`、`"2014-10-02T15:01:23+05:30"`。

rdbSnapshotPeriod

enum (SnapshotPeriod)

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

rdbSnapshotStartTime

string (Timestamp format)

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

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

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

enum (AppendFsync)

省略可。fsync 構成。

AppendFsync

利用可能な fsync モード。

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

ZoneDistributionConfig

クラスタリソースの割り当てのゾーン分布構成。

JSON 表現
{ "mode": enum (`ZoneDistributionMode`), "zone": string }

フィールド

フィールド
`mode`	`enum (ZoneDistributionMode)` 省略可。ゾーン分布のモード。指定しない場合、デフォルトは MULTI_ZONE です。
`zone`	`string` 省略可。SINGLE ZONE 分布を選択すると、ゾーンフィールドを使用して、そのゾーン内のすべてのリソースが割り当てられます。これは MULTI_ZONE には適用されず、MULTI_ZONE クラスタでは無視されます。

mode

enum (ZoneDistributionMode)

省略可。ゾーン分布のモード。指定しない場合、デフォルトは MULTI_ZONE です。

zone

string

省略可。SINGLE ZONE 分布を選択すると、ゾーンフィールドを使用して、そのゾーン内のすべてのリソースが割り当てられます。これは MULTI_ZONE には適用されず、MULTI_ZONE クラスタでは無視されます。

ZoneDistributionMode

ゾーン分布のさまざまなモードを定義します。

列挙型
`ZONE_DISTRIBUTION_MODE_UNSPECIFIED`	未設定。デフォルト: MULTI_ZONE
`MULTI_ZONE`	すべてのリソースをリージョン内の 3 つのゾーンにランダムに分散します。
`SINGLE_ZONE`	すべてのリソースを単一のゾーンに分散します。このモードを選択した場合は、ゾーンフィールドを指定する必要があります。

CrossClusterReplicationConfig

クロスクラスタレプリケーション構成。

JSON 表現

JSON 表現
{ "clusterRole": enum (`ClusterRole`), "primaryCluster": { object (`RemoteCluster`) }, "secondaryClusters": [ { object (`RemoteCluster`) } ], "updateTime": string, "membership": { object (`Membership`) } }

{
  "clusterRole": enum (ClusterRole),
  "primaryCluster": {
    object (RemoteCluster)
  },
  "secondaryClusters": [
    {
      object (RemoteCluster)
    }
  ],
  "updateTime": string,
  "membership": {
    object (Membership)
  }
}

フィールド
`clusterRole`	`enum (ClusterRole)` 出力専用。クロスクラスタレプリケーションにおけるクラスタのロール。
`primaryCluster`	`object (RemoteCluster)` このセカンダリクラスタのレプリケーションソースとして使用されるプライマリクラスタの詳細。このフィールドは、セカンダリクラスタに対してのみ設定されます。
`secondaryClusters[]`	`object (RemoteCluster)` このプライマリクラスタから複製されているセカンダリクラスタのリスト。このフィールドは、プライマリクラスタに対してのみ設定されます。
`updateTime`	`string (Timestamp format)` 出力専用。クロスクラスタレプリケーション構成が最後に更新された時刻。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: `"2014-10-02T15:01:23Z"`、`"2014-10-02T15:01:23.045123456Z"`、`"2014-10-02T15:01:23+05:30"`。
`membership`	`object (Membership)` 出力専用。クラスタ間レプリケーションに参加しているすべてのメンバークラスタの出力専用ビュー。このビューは、クラスタロール（プライマリまたはセカンダリ）に関係なく、すべてのメンバークラスタによって提供されます。プライマリクラスタは、そこから複製されているすべてのセカンダリクラスタに関する情報を提供できます。ただし、セカンダリクラスタは、レプリケート元のプライマリクラスタについてのみ認識します。ただし、プライマリクラスタが使用できないシナリオ（リージョン停止など）では、clusters.get リクエストを他のメンバークラスタに送信できます。このフィールドには、クラスタ間レプリケーションに参加しているすべてのメンバークラスタが一覧表示されます。

ClusterRole

クロスクラスタレプリケーションにおけるクラスタのロール。

列挙型
`CLUSTER_ROLE_UNSPECIFIED`	クラスタロールが設定されていません。動作は NONE と同等です。
`NONE`	このクラスタは、クラスタ間レプリケーションに参加していません。これは独立したクラスタであり、他のクラスタとの間でレプリケーションを行いません。
`PRIMARY`	読み取りと書き込みの両方が可能なクラスタ。このクラスタに書き込まれたデータは、接続されたセカンダリクラスタにも複製されます。
`SECONDARY`	読み取りのみを許可し、プライマリクラスタからデータを複製するクラスタ。

RemoteCluster

クラスタ間レプリケーション設定でこのクラスタに関連付けられているリモートクラスタの詳細。

JSON 表現
{ "cluster": string, "uid": string }

フィールド

フィールド
`cluster`	`string` 出力専用。リモートクラスタの完全なリソースパス（projects//locations//clusters/ の形式）
`uid`	`string` 出力専用。リモートクラスタの一意の識別子。

cluster

string

出力専用。リモートクラスタの完全なリソースパス（projects//locations//clusters/ の形式）

uid

string

出力専用。リモートクラスタの一意の識別子。

メンバーシップ

クラスタ間レプリケーションに参加しているすべてのメンバークラスタの出力専用ビュー。

JSON 表現
{ "primaryCluster": { object (`RemoteCluster`) }, "secondaryClusters": [ { object (`RemoteCluster`) } ] }

フィールド

フィールド
`primaryCluster`	`object (RemoteCluster)` 出力専用。セカンダリクラスタのレプリケーションのソースとして機能するプライマリクラスタ。
`secondaryClusters[]`	`object (RemoteCluster)` 出力専用。プライマリクラスタから複製するセカンダリクラスタのリスト。

primaryCluster

object (RemoteCluster)

出力専用。セカンダリクラスタのレプリケーションのソースとして機能するプライマリクラスタ。

secondaryClusters[]

object (RemoteCluster)

出力専用。プライマリクラスタから複製するセカンダリクラスタのリスト。

ClusterMaintenancePolicy

クラスタごとのメンテナンスポリシー。

JSON 表現
{ "createTime": string, "updateTime": string, "weeklyMaintenanceWindow": [ { object (`ClusterWeeklyMaintenanceWindow`) } ] }

フィールド

フィールド
`createTime`	`string (Timestamp format)` 出力専用。ポリシー（メンテナンスの時間枠や拒否期間など）が作成された日時。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: `"2014-10-02T15:01:23Z"`、`"2014-10-02T15:01:23.045123456Z"`、`"2014-10-02T15:01:23+05:30"`。
`updateTime`	`string (Timestamp format)` 出力専用。ポリシーが更新された時刻（メンテナンスの時間枠または拒否期間が更新された時刻）。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: `"2014-10-02T15:01:23Z"`、`"2014-10-02T15:01:23.045123456Z"`、`"2014-10-02T15:01:23+05:30"`。
`weeklyMaintenanceWindow[]`	`object (ClusterWeeklyMaintenanceWindow)` 省略可。このポリシーの対象となるリソースに適用されるメンテナンス時間枠。最小数 1。現在のバージョンでは、weeklyMaintenanceWindow の最大数は 1 つです。

createTime

string (Timestamp format)

出力専用。ポリシー（メンテナンスの時間枠や拒否期間など）が作成された日時。

updateTime

string (Timestamp format)

出力専用。ポリシーが更新された時刻（メンテナンスの時間枠または拒否期間が更新された時刻）。

weeklyMaintenanceWindow[]

object (ClusterWeeklyMaintenanceWindow)

省略可。このポリシーの対象となるリソースに適用されるメンテナンス時間枠。最小数 1。現在のバージョンでは、weeklyMaintenanceWindow の最大数は 1 つです。

ClusterWeeklyMaintenanceWindow

毎週のオペレーションに指定された時間枠。

JSON 表現
{ "day": enum (`DayOfWeek`), "startTime": { object (`TimeOfDay`) } }

フィールド

フィールド
`day`	`enum (DayOfWeek)` 省略可。指定した曜日に実行されるスケジュールを定義できます。
`startTime`	`object (TimeOfDay)` 省略可。時間枠の開始時刻（UTC）。

day

enum (DayOfWeek)

省略可。指定した曜日に実行されるスケジュールを定義できます。

startTime

object (TimeOfDay)

省略可。時間枠の開始時刻（UTC）。

ClusterMaintenanceSchedule

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

JSON 表現
{ "startTime": string, "endTime": string }

フィールド

フィールド
`startTime`	`string (Timestamp format)` 出力専用。このインスタンスに対する次回の定期メンテナンスの開始時刻。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: `"2014-10-02T15:01:23Z"`、`"2014-10-02T15:01:23.045123456Z"`、`"2014-10-02T15:01:23+05:30"`。
`endTime`	`string (Timestamp format)` 出力専用。このインスタンスに対する次回の定期メンテナンスの開始時刻。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: `"2014-10-02T15:01:23Z"`、`"2014-10-02T15:01:23.045123456Z"`、`"2014-10-02T15:01:23+05:30"`。

startTime

string (Timestamp format)

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

endTime

string (Timestamp format)

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

PscServiceAttachment

PSC 接続を作成するためのクラスタのサービスアタッチメントの構成。

JSON 表現
{ "serviceAttachment": string, "connectionType": enum (`ConnectionType`) }

フィールド

フィールド
`serviceAttachment`	`string` 出力専用。自分で作成した PscConnection がターゲットとして使用するサービスアタッチメント URI
`connectionType`	`enum (ConnectionType)` 出力専用。このサービスアタッチメントをターゲットとする PSC 接続のタイプ。

serviceAttachment

string

出力専用。自分で作成した PscConnection がターゲットとして使用するサービスアタッチメント URI

connectionType

enum (ConnectionType)

出力専用。このサービスアタッチメントをターゲットとする PSC 接続のタイプ。

ClusterEndpoint

ClusterEndpoint は、クラスタにアクセスするために各 VPC ネットワークでグループとして作成される PSC 接続で構成されます。各グループには、クラスタ内のサービスアタッチメントごとに 1 つの接続が必要です。

JSON 表現
{ "connections": [ { object (`ConnectionDetail`) } ] }

フィールド

フィールド
`connections[]`	`object (ConnectionDetail)` 必須。PSC 接続のグループ。これらは同じ VPC ネットワークに作成され、クラスタ内のサービスアタッチメントごとに 1 つ作成されます。

connections[]

object (ConnectionDetail)

必須。PSC 接続のグループ。これらは同じ VPC ネットワークに作成され、クラスタ内のサービスアタッチメントごとに 1 つ作成されます。

ConnectionDetail

各 PSC 接続の詳細情報。

JSON 表現

{

  // Union field connection can be only one of the following:
  "pscAutoConnection": {
    object (PscAutoConnection)
  },
  "pscConnection": {
    object (PscConnection)
  }
  // End of list of possible types for union field connection.
}

Fields

共用体フィールド connection。クラスタへの PSC 接続は、クラスタの作成時にサービス接続の自動化（自動登録接続）によって作成することも、ユーザー自身が作成することもできます（ユーザー登録接続）。connection は次のいずれかになります。

pscAutoConnection

object (PscAutoConnection)

サービス接続の自動化によって作成された PSC 接続の詳細情報。

pscConnection

object (PscConnection)

クラスタを所有するお客様が作成した PSC 接続の詳細情報。

PscAutoConnection

サービス接続の自動化によって作成された PSC 接続のコンシューマーリソースの詳細。

JSON 表現

{
  "pscConnectionId": string,
  "address": string,
  "forwardingRule": string,
  "projectId": string,
  "network": string,
  "serviceAttachment": string,
  "pscConnectionStatus": enum (PscConnectionStatus),
  "connectionType": enum (ConnectionType)
}

フィールド
`pscConnectionId`	`string` 出力専用。サービスアタッチメントに接続されている転送ルールの PSC 接続 ID。
`address`	`string` 出力専用。PSC 転送ルール用にコンシューマーネットワークに割り当てられている IP。
`forwardingRule`	`string` 出力専用。コンシューマー側の転送ルールの URI。例: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}。
`projectId`	`string` 必須。転送ルールが作成されるコンシューマーの projectId。
`network`	`string` 必須。IP アドレスが存在するコンシューマーネットワーク。形式: projects/{projectId}/global/networks/{network_id}
`serviceAttachment`	`string` 出力専用。PSC 接続のターゲットであるサービスアタッチメント。形式は projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id} です。
`pscConnectionStatus`	`enum (PscConnectionStatus)` 出力専用。PSC 接続のステータス。この値は定期的に更新されます。最新のステータスについては、Private Service Connect API を使用してください。
`connectionType`	`enum (ConnectionType)` 出力専用。PSC 接続のタイプ。

AutomatedBackupConfig

クラスタの自動バックアップ構成。

JSON 表現

{
  "automatedBackupMode": enum (AutomatedBackupMode),

  // Union field schedule can be only one of the following:
  "fixedFrequencySchedule": {
    object (FixedFrequencySchedule)
  }
  // End of list of possible types for union field schedule.
  "retention": string
}

フィールド
`automatedBackupMode`	`enum (AutomatedBackupMode)` 省略可。自動バックアップモード。モードが無効になっている場合、他のフィールドは無視されます。
共用体フィールド `schedule`。自動バックアップのスケジュール。`schedule` は次のいずれかになります。
`fixedFrequencySchedule`	`object (FixedFrequencySchedule)` 省略可。固定頻度で自動バックアップをトリガーします。
`retention`	`string (Duration format)` 省略可。自動バックアップが削除されるまでの保持期間。値は 1 ～ 365 日の範囲で指定してください。指定しない場合、デフォルト値は 35 日です。 `s` で終わる小数点以下 9 桁までの秒単位の期間。例: `"3.5s"`。

FixedFrequencySchedule

このスケジュールでは、バックアップを一定の頻度でトリガーできます（現在は毎日のみサポートされています）。

JSON 表現
{ "startTime": { object (`TimeOfDay`) } }

フィールド

startTime

object (TimeOfDay)

必須。すべての自動バックアップの開始時刻（UTC）。開始時刻は正時に設定する必要があります。このフィールドは必須です。

AutomatedBackupMode

自動バックアップモード。

列挙型
`AUTOMATED_BACKUP_MODE_UNSPECIFIED`	デフォルト値。自動バックアップ構成が指定されていません。
`DISABLED`	自動バックアップ構成が無効になっています。
`ENABLED`	自動バックアップ構成が有効になっています。

メソッド
`backup`	Redis クラスタをバックアップします。
`create`	指定されたプロパティに基づいて Redis クラスタを作成します。
`delete`	特定の Redis クラスタを削除します。
`get`	特定の Redis クラスタの詳細を取得します。
`getCertificateAuthority`	Redis クラスタの認証局情報の詳細を取得します。
`list`	指定されたロケーション（リージョン）またはすべてのロケーションにあるプロジェクトが所有するすべての Redis クラスタを一覧表示します。
`patch`	特定の Redis クラスタのメタデータと構成を更新します。
`rescheduleClusterMaintenance`	今後のメンテナンスイベントのスケジュールを変更します。

REST Resource: projects.locations.clusters コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

リソース: Cluster

GcsBackupSource

ManagedBackupSource

状態

AuthorizationMode

TransitEncryptionMode

PscConfig

DiscoveryEndpoint

PscConnection

PscConnectionStatus

ConnectionType

StateInfo

UpdateInfo

ClusterPersistenceConfig

PersistenceMode

RDBConfig

SnapshotPeriod

AOFConfig

AppendFsync

ZoneDistributionConfig

ZoneDistributionMode

CrossClusterReplicationConfig

ClusterRole

RemoteCluster

メンバーシップ

ClusterMaintenancePolicy

ClusterWeeklyMaintenanceWindow

ClusterMaintenanceSchedule

PscServiceAttachment

ClusterEndpoint

ConnectionDetail

PscAutoConnection

AutomatedBackupConfig

FixedFrequencySchedule

AutomatedBackupMode

メソッド

REST Resource: projects.locations.clusters