REST Resource: projects.locations.backupCollections.backups

リソース: バックアップ

クラスタのバックアップ。

JSON 表現
{
  "name": string,
  "createTime": string,
  "cluster": string,
  "clusterUid": string,
  "totalSizeBytes": string,
  "expireTime": string,
  "engineVersion": string,
  "backupFiles": [
    {
      object (BackupFile)
    }
  ],
  "nodeType": enum (NodeType),
  "replicaCount": integer,
  "shardCount": integer,
  "backupType": enum (BackupType),
  "state": enum (State),
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "uid": string
}
フィールド
name

string

ID。バックアップの完全なリソースパス。名前の最後の部分は、[YYYYMMDDHHMMSS]_[短縮クラスタ UID] の形式のバックアップ ID、またはバックアップ クラスタでユーザーが指定した ID です。例: 20240515123000_1234

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"

cluster

string

出力専用。このバックアップのクラスタ リソースパス。

clusterUid

string

出力専用。このバックアップのクラスタ UID。

totalSizeBytes

string (int64 format)

出力専用。バックアップの合計サイズ(バイト単位)。

expireTime

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"

engineVersion

string

出力のみ。redis-7.2、valkey-7.5

backupFiles[]

object (BackupFile)

出力専用。バックアップのバックアップ ファイルのリスト。

nodeType

enum (NodeType)

出力専用。クラスタのノードタイプ。

replicaCount

integer

出力専用。クラスタのレプリカ数。

shardCount

integer

出力専用。クラスタのシャード数。

backupType

enum (BackupType)

出力専用。バックアップのタイプ。

state

enum (State)

出力専用。バックアップの状態。

encryptionInfo

object (EncryptionInfo)

出力専用。バックアップの暗号化情報。

uid

string

出力専用。システムによって割り当てられたバックアップの固有識別子。

BackupFile

バックアップは複数のバックアップ ファイルで構成されています。

JSON 表現
{
  "fileName": string,
  "sizeBytes": string,
  "createTime": string
}
フィールド
fileName

string

出力のみ。例: .rdb

sizeBytes

string (int64 format)

出力専用。バックアップ ファイルのサイズ(バイト単位)。

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"

BackupType

バックアップのタイプ。

列挙型
BACKUP_TYPE_UNSPECIFIED デフォルト値。設定されていません。
ON_DEMAND オンデマンド バックアップ。
AUTOMATED 自動バックアップ。

状態

バックアップの状態。

列挙型
STATE_UNSPECIFIED デフォルト値。設定されていません。
CREATING バックアップを作成しています。
ACTIVE バックアップは使用可能な状態です。
DELETING バックアップを削除しています。
SUSPENDED バックアップは、プロジェクトの削除や請求先アカウントの閉鎖などの理由により、現在一時停止されています。

メソッド

delete

特定のバックアップを削除します。

export

特定のバックアップを顧客のターゲット Cloud Storage URI にエクスポートします。

get

特定のバックアップの詳細を取得します。

list

バックアップ コレクションが所有するすべてのバックアップを一覧表示します。