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

REST Resource: projects.locations.instances

リソース: インスタンス
- JSON 表現
GcsBackupSource
- JSON 表現
ManagedBackupSource
- JSON 表現
状態
StateInfo
- JSON 表現
UpdateInfo
- JSON 表現
AuthorizationMode
TransitEncryptionMode
DiscoveryEndpoint
- JSON 表現
PersistenceConfig
- JSON 表現
PersistenceMode
RDBConfig
- JSON 表現
SnapshotPeriod
AOFConfig
- JSON 表現
AppendFsync
NodeConfig
- JSON 表現
ZoneDistributionConfig
- JSON 表現
ZoneDistributionMode
PscAutoConnection
- JSON 表現
PscConnectionStatus
ConnectionType
PscAttachmentDetail
- JSON 表現
InstanceEndpoint
- JSON 表現
ConnectionDetail
- JSON 表現
PscConnection
- JSON 表現
Mode
MaintenancePolicy
- JSON 表現
WeeklyMaintenanceWindow
- JSON 表現
MaintenanceSchedule
- JSON 表現
CrossInstanceReplicationConfig
- JSON 表現
InstanceRole
RemoteInstance
- JSON 表現
メンバーシップ
- JSON 表現
AutomatedBackupConfig
- JSON 表現
FixedFrequencySchedule
- JSON 表現
AutomatedBackupMode
メソッド

リソース: インスタンス

Memorystore インスタンス。

JSON 表現

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`) } ], "pscAttachmentDetails": [ { object (`PscAttachmentDetail`) } ], "endpoints": [ { object (`InstanceEndpoint`) } ], "mode": enum (`Mode`), "maintenancePolicy": { object (`MaintenancePolicy`) }, "maintenanceSchedule": { object (`MaintenanceSchedule`) }, "crossInstanceReplicationConfig": { object (`CrossInstanceReplicationConfig`) }, "encryptionInfo": { object (`EncryptionInfo`) }, "automatedBackupConfig": { object (`AutomatedBackupConfig`) }, "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, "deletionProtectionEnabled": boolean, "simulateMaintenanceEvent": boolean, "ondemandMaintenance": boolean, "satisfiesPzs": boolean, "satisfiesPzi": boolean, "asyncInstanceEndpointsDeletionEnabled": boolean, "kmsKey": string, "backupCollection": string }

{
  "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)
    }
  ],
  "pscAttachmentDetails": [
    {
      object (PscAttachmentDetail)
    }
  ],
  "endpoints": [
    {
      object (InstanceEndpoint)
    }
  ],
  "mode": enum (Mode),
  "maintenancePolicy": {
    object (MaintenancePolicy)
  },
  "maintenanceSchedule": {
    object (MaintenanceSchedule)
  },
  "crossInstanceReplicationConfig": {
    object (CrossInstanceReplicationConfig)
  },
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "automatedBackupConfig": {
    object (AutomatedBackupConfig)
  },
  "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,
  "deletionProtectionEnabled": boolean,
  "simulateMaintenanceEvent": boolean,
  "ondemandMaintenance": boolean,
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean,
  "asyncInstanceEndpointsDeletionEnabled": boolean,
  "kmsKey": string,
  "backupCollection": string
}

フィールド
`name`	`string` ID。インスタンスの一意の名前。形式: projects/{project}/locations/{location}/instances/{instance}
`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"`。
`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[] (deprecated)`	`object (DiscoveryEndpoint)` この項目は非推奨です。出力専用。非推奨: discoveryEndpoints パラメータは非推奨になりました。そのため、エンドポイントパラメータを使用して接続が作成された場合、このフィールドは入力されません。このパラメータの代わりに、検出には connectionType CONNECTION_TYPE_DISCOVERY を使用して endpoints.connections.pscConnection と endpoints.connections.pscAutoConnection を使用します。
`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)` 省略可。変更不可。非推奨: 代わりに endpoints.connections.psc_auto_connection 値を使用してください。
`pscAttachmentDetails[]`	`object (PscAttachmentDetail)` 出力専用。PSC 接続を構成するためのサービスアタッチメントの詳細。
`endpoints[]`	`object (InstanceEndpoint)` 省略可。インスタンスのエンドポイント。
`mode`	`enum (Mode)` 省略可。インスタンスのモード構成。
`maintenancePolicy`	`object (MaintenancePolicy)` 省略可。インスタンスのメンテナンスポリシー。指定しない場合、メンテナンスイベントは Memorystore の内部ロールアウトスケジュールに基づいて実行されます。
`maintenanceSchedule`	`object (MaintenanceSchedule)` 出力専用。公開されたメンテナンススケジュール。
`crossInstanceReplicationConfig`	`object (CrossInstanceReplicationConfig)` 省略可。クロスインスタンスレプリケーションの構成。
`encryptionInfo`	`object (EncryptionInfo)` 出力専用。クラスタの保存データの暗号化情報。
`automatedBackupConfig`	`object (AutomatedBackupConfig)` 省略可。インスタンスの自動バックアップ構成。
`allowFewerZonesDeployment`	`boolean` 省略可。変更不可。3 つ未満のゾーンにマルチゾーンインスタンスをデプロイしてもよいかどうかを指定できます。設定後、インスタンスの作成中にゾーンの停止が発生した場合、インスタンスは 2 つのゾーンにのみデプロイされ、ライフサイクル全体を通じて 2 つのゾーン内に留まります。
共用体フィールド `import_sources`。インポート元のソース。`import_sources` は次のいずれかになります。
`gcsSource`	`object (GcsBackupSource)` 省略可。変更不可。Cloud Storage バケットに保存されたバックアップ。Cloud Storage バケットは、インスタンスと同じリージョンに存在する必要があります。指定された Cloud Storage オブジェクトからインポートするには、読み取り権限が必要です。
`managedBackupSource`	`object (ManagedBackupSource)` 省略可。変更不可。Memorystore サービスによって生成および管理されるバックアップ。
`replicaCount`	`integer` 省略可。シャードあたりのレプリカノードの数。省略した場合、デフォルトは 0 レプリカです。
`deletionProtectionEnabled`	`boolean` 省略可。true に設定すると、インスタンスの削除は失敗します。
`simulateMaintenanceEvent`	`boolean` 省略可。入力専用。メンテナンスイベントをシミュレートします。
`ondemandMaintenance (deprecated)`	`boolean` この項目は非推奨です。省略可。入力専用。インスタンスのオンデマンドメンテナンス。
`satisfiesPzs`	`boolean` 省略可。出力専用。将来の使用のために予約。
`satisfiesPzi`	`boolean` 省略可。出力専用。将来の使用のために予約。
`asyncInstanceEndpointsDeletionEnabled`	`boolean` 省略可。true の場合、お客様が作成して登録したインスタンスエンドポイントを非同期で削除できます。つまり、このようなインスタンスエンドポイントは、インスタンスエンドポイントの転送ルールが削除される前に登録解除できます。
`kmsKey`	`string` 省略可。クラスタの保存データを暗号化するために使用される KMS 鍵。
`backupCollection`	`string` 出力専用。バックアップコレクションの完全なリソース名。例: projects/{project}/locations/{location}/backupCollections/{collection}

GcsBackupSource

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

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

フィールド

フィールド
`uris[]`	`string` 省略可。例: gs://bucket1/object1、gs://bucket2/folder2/object2

uris[]

string

省略可。例: gs://bucket1/object1、gs://bucket2/folder2/object2

ManagedBackupSource

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

JSON 表現
{ "backup": string }

フィールド

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

backup

string

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

状態

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

列挙型
`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 の場合に、進行中の更新について説明します。

共用体フィールド info。

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

updateInfo

object (UpdateInfo)

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

UpdateInfo

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

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

フィールド
`targetShardCount`	`integer` 出力専用。インスタンスのシャードの目標数。
`targetReplicaCount`	`integer` 出力専用。インスタンスのシャードあたりのレプリカノードの目標数。
`targetEngineVersion`	`string` 出力専用。インスタンスのターゲットエンジンバージョン。
`targetNodeType`	`enum (NodeType)` 出力専用。インスタンスのターゲットノードタイプ。

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}）。

address

string

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

port

integer

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

network

string

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

PersistenceConfig

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

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

NodeConfig

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

JSON 表現
{ "sizeGb": number }

フィールド

フィールド
`sizeGb`	`number` 出力専用。ノードのメモリサイズ（GB）。

sizeGb

number

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

ZoneDistributionConfig

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

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

フィールド

フィールド
`zone`	`string` 省略可。すべてのリソースが SINGLE_ZONE モードで割り当てられるゾーンを定義します。MULTI_ZONE モードでは無視されます。
`mode`	`enum (ZoneDistributionMode)` 省略可。現在のゾーン分布モード。デフォルトは MULTI_ZONE です。

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 表現

JSON 表現
{ "pscConnectionId": string, "ipAddress": 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,
  "ipAddress": 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。
`ipAddress`	`string` 出力専用。PSC 転送ルール用にコンシューマーネットワークに割り当てられている IP。
`forwardingRule`	`string` 出力専用。コンシューマー側の転送ルールの URI。形式: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
`projectId`	`string` 必須。PSC 接続が確立されるコンシューマーの projectId。これは、インスタンスが作成されるプロジェクトと同じ projectId にする必要があります。
`network`	`string` 必須。PSC エンドポイントが作成されるネットワーク。形式は 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 接続のタイプ。
共用体フィールド `ports`。公開されているエンドポイントのポート。`ports` は次のいずれかになります。
`port`	`integer` 省略可。ポートは、プライマリ/リーダーまたは検出エンドポイントに対してのみ設定されます。

PscConnectionStatus

PSC 接続のステータス。

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

ConnectionType

PSC 接続のタイプ

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

PscAttachmentDetail

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

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

フィールド

フィールド
`serviceAttachment`	`string` 出力専用。ユーザーが作成した PscConnection がターゲットとして使用するサービスアタッチメント URI。
`connectionType`	`enum (ConnectionType)` 出力専用。Psc エンドポイントのタイプ。

serviceAttachment

string

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

connectionType

enum (ConnectionType)

出力専用。Psc エンドポイントのタイプ。

InstanceEndpoint

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

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

フィールド

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

connections[]

object (ConnectionDetail)

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

ConnectionDetail

各 PSC 接続の情報。

JSON 表現

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`. }

{

  // 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

Fields
共用体フィールド `connection`。インスタンスへの PSC 接続は、クラスタの作成時にサービス接続の自動化（自動接続）によって作成することも、ユーザー自身が作成することもできます（ユーザー作成接続）。`connection` は次のいずれかになります。
`pscAutoConnection`	`object (PscAutoConnection)` 変更不可。サービス接続の自動化によって作成された PSC 接続の詳細情報。
`pscConnection`	`object (PscConnection)` ユーザーが作成した PSC 接続の詳細情報。

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

pscAutoConnection

object (PscAutoConnection)

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

pscConnection

object (PscConnection)

ユーザーが作成した PSC 接続の詳細情報。

PscConnection

ユーザーが PSC 接続構成を作成しました。

JSON 表現

JSON 表現
{ "pscConnectionId": string, "ipAddress": 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,
  "ipAddress": 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。
`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}
`serviceAttachment`	`string` 必須。PSC 接続のターゲットであるサービスアタッチメント。形式は projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id} です。
`pscConnectionStatus`	`enum (PscConnectionStatus)` 出力専用。PSC 接続のステータス: 接続が存在して有効であるか、存在しなくなったか。この値は定期的に更新されます。最新のステータスについては、Private Service Connect API を使用してください。
`connectionType`	`enum (ConnectionType)` 出力専用。PSC 接続のタイプ。
共用体フィールド `ports`。公開されているエンドポイントのポート。`ports` は次のいずれかになります。
`port`	`integer` 省略可。ポートは、プライマリ/リーダーまたは検出エンドポイントに対してのみ設定されます。

モード

クラスタモードの有効化/無効化に使用されるモード構成。

列挙型
`MODE_UNSPECIFIED`	モードが指定されていません。
`STANDALONE`	非推奨: 代わりに CLUSTER_DISABLED を使用してください。この項目は非推奨です。
`CLUSTER`	インスタンスはクラスタモードです。
`CLUSTER_DISABLED`	インスタンスでクラスタモードが無効になっている。

MaintenancePolicy

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

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

フィールド

フィールド
`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 (WeeklyMaintenanceWindow)` 省略可。このポリシーの対象となるリソースに適用されるメンテナンス時間枠。最小数 1。現在のバージョンでは、weekly_window の最大数は 1 になることが想定されています。

createTime

string (Timestamp format)

出力専用。ポリシーの作成時間。

updateTime

string (Timestamp format)

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

weeklyMaintenanceWindow[]

object (WeeklyMaintenanceWindow)

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

WeeklyMaintenanceWindow

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

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

フィールド

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

day

enum (DayOfWeek)

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

startTime

object (TimeOfDay)

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

MaintenanceSchedule

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

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)

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

CrossInstanceReplicationConfig

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

JSON 表現

JSON 表現
{ "instanceRole": enum (`InstanceRole`), "primaryInstance": { object (`RemoteInstance`) }, "secondaryInstances": [ { object (`RemoteInstance`) } ], "updateTime": string, "membership": { object (`Membership`) } }

{
  "instanceRole": enum (InstanceRole),
  "primaryInstance": {
    object (RemoteInstance)
  },
  "secondaryInstances": [
    {
      object (RemoteInstance)
    }
  ],
  "updateTime": string,
  "membership": {
    object (Membership)
  }
}

フィールド
`instanceRole`	`enum (InstanceRole)` 必須。クロスインスタンスレプリケーションにおけるインスタンスのロール。
`primaryInstance`	`object (RemoteInstance)` 省略可。このセカンダリインスタンスのレプリケーションソースとして使用されるプライマリインスタンスの詳細。このフィールドは、セカンダリインスタンスに対してのみ設定されます。
`secondaryInstances[]`	`object (RemoteInstance)` 省略可。このプライマリインスタンスから複製しているセカンダリインスタンスのリスト。このフィールドは、プライマリインスタンスに対してのみ設定されます。
`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)` 出力専用。クロスインスタンスレプリケーションに参加しているすべてのメンバーインスタンスの出力専用ビュー。このビューは、インスタンスのロール（プライマリまたはセカンダリ）に関係なく、すべてのメンバーインスタンスによって提供されます。プライマリインスタンスは、そこからレプリケートしているすべてのセカンダリインスタンスに関する情報を提供できます。ただし、セカンダリインスタンスは、レプリケート元のプライマリインスタンスのみを認識します。ただし、プライマリインスタンスが使用できないシナリオ（リージョン停止など）では、Getinstance リクエストを他のメンバーインスタンスに送信できます。このフィールドには、インスタンス間のレプリケーションに参加しているすべてのメンバーインスタンスが一覧表示されます。

InstanceRole

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

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

RemoteInstance

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

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

フィールド

instance

string

省略可。リモートインスタンスの完全なリソースパス。形式は projects//locations//instances/ です。

uid

string

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

メンバーシップ

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

JSON 表現
{ "primaryInstance": { object (`RemoteInstance`) }, "secondaryInstances": [ { object (`RemoteInstance`) } ] }

フィールド

primaryInstance

object (RemoteInstance)

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

secondaryInstances[]

object (RemoteInstance)

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

AutomatedBackupConfig

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

JSON 表現

{
  "automatedBackupMode": enum (AutomatedBackupMode),
  "retention": string,

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

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

FixedFrequencySchedule

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

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

フィールド

startTime

object (TimeOfDay)

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

AutomatedBackupMode

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

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

メソッド
`backup`	インスタンスをバックアップします。
`create`	指定されたプロジェクトとロケーションで新しいインスタンスを作成します。
`delete`	1 つのインスタンスを削除します。
`get`	1 つのインスタンスの詳細を取得します。
`getCertificateAuthority`	インスタンスの認証局の詳細を取得します。
`list`	指定されたプロジェクトとロケーションでのインスタンスを一覧で表示します。
`patch`	単一インスタンスのパラメータを更新します。
`rescheduleMaintenance`	今後のメンテナンスイベントのスケジュールを変更します。

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

リソース: インスタンス

GcsBackupSource

ManagedBackupSource

状態

StateInfo

UpdateInfo

AuthorizationMode

TransitEncryptionMode

DiscoveryEndpoint

PersistenceConfig

PersistenceMode

RDBConfig

SnapshotPeriod

AOFConfig

AppendFsync

NodeConfig

ZoneDistributionConfig

ZoneDistributionMode

PscAutoConnection

PscConnectionStatus

ConnectionType

PscAttachmentDetail

InstanceEndpoint

ConnectionDetail

PscConnection

モード

MaintenancePolicy

WeeklyMaintenanceWindow

MaintenanceSchedule

CrossInstanceReplicationConfig

InstanceRole

RemoteInstance

メンバーシップ

AutomatedBackupConfig

FixedFrequencySchedule

AutomatedBackupMode

メソッド

REST Resource: projects.locations.instances