KRM API backup.gdc.goog/v1

backup.gdc.goog/v1

バックアップ

Backup API のスキーマを定義します。

表示場所: - BackupList

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 Backup
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec BackupSpec
status BackupStatus

BackupConfig

このバックアップ プランからバックアップを作成する構成を定義する内部メッセージ タイプを表します。

表示される場所: - BackupPlanSpec - BackupSpec

フィールド 説明
backupScope BackupScope バックアップのリソース選択スコープ。たとえば、all_namespaces、選択した Namespace、選択したアプリケーションなどがあります。backup_scope には 1 つの値を指定する必要があります。BackupScope の値は、BackupConfig_AllNamespaces、BackupConfig_SelectedNamespaces、BackupConfig_SelectedApplications のいずれかの型にする必要があります。
backupRepository 文字列 この BackupPlan リソースのセカンダリ ストレージを識別する BackupRepository リソースの名前。
includeVolumeData ブール値 ボリューム データがバックアップされるかどうかを指定します。設定しなかった場合、デフォルトは False です。
includeSecrets ブール値 シークレットがバックアップされるかどうかを指定します。設定しなかった場合、デフォルトは False です。
encryptionKey EncryptionKey 暗号鍵。このフィールドは変更できません。
volumeStrategy VolumeStrategy ボリュームのバックアップ時に使用するトレードオフ。

BackupInfo

RecentBackups フィールドにバックアップの名前と状態を表します。

表示場所: - BackupPlanStatus

フィールド 説明
name 文字列 バックアップの名前。
state BackupState 最後に実行されたバックアップのステータス。

BackupList

バックアップのリストが含まれます。

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 BackupList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items バックアップの配列

BackupPlan

BackupPlan API のスキーマを定義します。

表示場所: - BackupPlanList

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 BackupPlan
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec BackupPlanSpec
status BackupPlanStatus

BackupPlanList

バックアップ プランのリストが含まれます。

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 BackupPlanList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items BackupPlan の配列

BackupPlanSpec

バックアップ プランの望ましい状態を定義します。

表示場所: - BackupPlan

フィールド 説明
clusterName 文字列 このバックアップ プランがバックアップするデータを含むクラスタの名前。デフォルトでは、このバックアップ プランが作成されたクラスタです。
backupSchedule スケジュール このバックアップ プランに基づくスケジュールされたバックアップの作成。
backupConfig BackupConfig このバックアップ プランのバックアップ構成。
retentionPolicy RetentionPolicy このプランで作成されたバックアップのライフサイクル。
description 文字列 このバックアップ プランについてユーザーが指定した説明文字列。
deactivated ブール値 プランが無効になっているかどうかを指定します。このフィールドを True に設定すると、プランがロックされ、無効化されたフィールドの変更を含め、それ以降の更新は許可されなくなります。また、このプランで新しいバックアップが手動またはスケジュール設定で作成されないようにします。デフォルトは「False」です。

BackupPlanStatus

バックアップ プランの観測状態を定義します。

表示場所: - BackupPlan

フィールド 説明
lastBackupTime 時間 最後に実行されたバックアップのタイムスタンプ。
nextBackupTime 時間 次回スケジュールされているバックアップのタイムスタンプ。
state 都道府県 バックアップ プランの現在の状態。
lastBackupState BackupState 最後に作成されたバックアップの状態。
lastBackupStateReason 文字列 最後のバックアップが現在の状態である理由に関する説明（人が読める形式）。
errorStatus ErrorStatus 直近のエラーと観測時刻が含まれます。
conditions 条件の配列 conditions は、このバックアップ プランの現在の状態の観測値を表します。
recentBackups BackupInfo 配列 バックアップ プランによって作成された最新のバックアップ。

BackupRepository

BackupRepository API のスキーマを定義します。

表示場所: - BackupRepositoryList

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 BackupRepository
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec BackupRepositorySpec
status BackupRepositoryStatus

BackupRepositoryList

バックアップ リポジトリ リソースのリストが含まれます。

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 BackupRepositoryList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items BackupRepository 配列

BackupRepositoryManager

BackupRepositoryManager は、backuprepositorymanagers API のスキーマです

表示場所: - BackupRepositoryManagerList

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 BackupRepositoryManager
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec BackupRepositoryManagerSpec
status BackupRepositoryManagerStatus

BackupRepositoryManagerList

BackupRepositoryManagerList には BackupRepositoryManager のリストが含まれます

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 BackupRepositoryManagerList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items BackupRepositoryManager 配列

BackupRepositoryManagerSpec

BackupRepositoryManagerSpec は、BackupRepositoryManager の望ましい状態を定義します

表示場所: - BackupRepositoryManager

フィールド 説明
backupRepositorySpec BackupRepositorySpec BackupRepositorySpec には、ユーザー クラスタ内にバックアップ リポジトリを作成するために必要なすべての詳細が含まれています。BackupRepositorySpec の ImportPolicy フィールドはここでは考慮されません。作成される BackupRepository は、作成先のクラスタが ReadWriteCluster の場合は「ReadWrite」になります。作成先のクラスタが ReadOnlyClusters リストに存在する場合は、「ReadOnly」になります。このフィールドは変更できません。
readWriteCluster NamespacedName ReadWriteCluster は、BackupRepositorySpec フィールドのデータを使用して ReadWrite バックアップ リポジトリを作成する権限を持つ単一のクラスタ（baremetal.cluster.gke.io/Cluster）を指定します。ReadWrite リポジトリは、バックアップ、BackupPlan、復元のスケジュール設定と作成に使用でき、作成されたクラスタによって実質的に所有されます。注: BackupRepository を ReadWrite として使用できるのは、最大で 1 つの k8s クラスタのみです。このフィールドは変更可能です。
readOnlyClusters NamespacedName 配列 ReadOnlyClusters は、BackupRepositorySpec フィールドのデータを使用して ReadOnly バックアップ リポジトリを作成する権限を持つクラスタ（baremetal.cluster.gke.io/Cluster）のリストを指定します。ReadOnly リポジトリは、バックアップのインポートと表示にのみ使用できます。このリポジトリに新しいバックアップ/リソースを作成することはできませんが、復元では読み取り専用バックアップを使用して参照できます。クラスタ間の復元のために別のクラスタからバックアップをインポートすることを目的としています。BackupRepository を ReadOnly として使用する頻度に制限はありません。このフィールドは変更可能です。

BackupRepositoryManagerStatus

BackupRepositoryManagerStatus は、BackupRepositoryManager の観測された状態を定義します。

表示場所: - BackupRepositoryManager

フィールド 説明
backupCount 整数 BackupCount は、BackupRepositorySpec が指すストレージ バケット内に作成されたバックアップの合計数です。
backupPlanCount 整数 BackupPlanCount は、BackupRepositorySpec が指すストレージ バケット内に作成されたバックアップ プランの合計数です。
restoreCount 整数 RestoreCount は、BackupRepositorySpec が指すストレージ バケット内に作成された復元の合計数です。
restorePlanCount 整数 RestorePlanCount は、BackupRepositorySpec が指すストレージ バケット内に作成された復元プランの合計数です。
clusterStatuses ClusterStatus 配列 ClusterStatuses には、各クラスタで目的のバックアップ リポジトリを作成する際の現在のステータスが含まれています。このリストには、ReadOnlyClusters リストで指定されたすべてのクラスタと ReadWriteCluster のエントリが含まれます。クラスタでバックアップ リポジトリが正常に作成されたかどうかは、ClusterStatuses 配列のエントリの「Ready」条件が「True」かどうかで判断します。それ以外の場合は「False」になります。
conditions 条件 条件は、バックアップ リポジトリ マネージャーとその作成されたバックアップ リポジトリが正常な状態であるかどうかを示します。
errorStatus ErrorStatus 調整の最新のエラーと、観測された時刻が含まれます。

BackupRepositorySpec

バックアップ リポジトリの望ましい状態を定義します。

表示場所: - BackupRepository

フィールド 説明
secretReference SecretReference 選択したストレージ システムに依存するアクセス シークレットへの参照。この Secret は、このエンドポイントへのリクエストで使用されます。たとえば、S3 アクセス シークレットなどです。
endpoint 文字列 バックアップ リポジトリへのアクセスに使用されるエンドポイント。Google Private Cloud の場合、これはテナント プロジェクトへのアクセスを提供する S3 エンドポイントです。
type RepositoryType バックアップ リポジトリのタイプ。たとえば、S3 や Google Cloud Storage などです。これにより、使用するストレージ システムまたは API がエージェントに指示されます。
s3Options S3Options S3 互換の BackupRepo リソースへのアクセスを構成するために使用されるデータ。
importPolicy ImportPolicy このバックアップ リポジトリが読み取り専用か読み取り / 書き込みかを決定するポリシー。
importSubstitution ImportSubstitution このフィールドは、インポートされたリソースのバックアップ リポジトリ名をこのバックアップ リポジトリ名に置き換えるかどうかを決定します。
force ブール値 初期化されたストレージ バケットが別のバックアップ リポジトリによってすでに要求されている場合に、読み取り / 書き込みバックアップ リポジトリが実行するアクションを指定します。True の場合、新しいバックアップ リポジトリは、既存のセンチネル ファイルを独自のセンチネル ファイルに置き換えることで、ストレージ バケットの所有権を主張します。False の場合、新しいバックアップ リポジトリの作成はエラーで失敗します。デフォルト値は False です。これは、オーバーライドされたセンチネル ファイルにバックアップ リポジトリがなくなった場合にのみ使用する必要があります。そうしないと、バックアップ リポジトリがエラー状態になり、望ましくない副作用が発生する可能性があります。

BackupRepositoryStatus

バックアップ リポジトリの観測された状態を定義します。

表示場所: - BackupRepository

フィールド 説明
sentinelEtag 文字列 バックアップ リポジトリを所有するセンチネル ファイルに接続するフィールド。
reconciliationError ReconciliationError バックアップ リポジトリの直近の調整試行中に発生したエラー。
reconciliationErrorMessage 文字列 調整中に発生した可能性のあるエラー メッセージ。
errorStatus ErrorStatus 調整の最新のエラーと、観測された時刻が含まれます。
initialImportDone ブール値 このバックアップ リポジトリで最初のインポートが完了したかどうかを指定します。
conditions 条件の配列 conditions は、このバックアップ リポジトリの現在の状態の観測値を表します。既知の条件タイプ: Ready。

BackupRetentionPolicy

バックアップの保持ポリシーを表します

表示場所: - ClusterBackupSpec

フィールド 説明
deleteLockDays 整数 このバックアップの作成から削除がブロックされるまでの日数。バックアップ スケジュールから自動的に作成されたバックアップの場合、このフィールドは ClusterBackupPlan.RetentionPolicy.backup_delete_block_days の値に設定されます。このフィールドを指定せずに手動で作成されたバックアップの場合、サービスは ClusterBackupPlan.RetentionPolicy.backup_delete_block_days の値を割り当てます。このフィールドの値が ClusterBackupPlan.RetentionPolicy.backup_delete_block_days の値よりも小さいバックアップが作成されると、サービスから無効な回答が返されます。このフィールドは、0-90 の整数値でなければなりません。このフィールドは更新リクエストによってのみ増やす必要があります。そうでない場合、サービスから無効な回答が返されます。このフィールドは、Succeeded 状態のバックアップにのみ適用されます。
retainDays 整数 このクラスタ バックアップを保持する日数。この日数を過ぎると、バックアップは自動的に削除されます。これは、クラスタ バックアップの create_time から計算されます。このフィールドが指定されていない場合、または 0 に設定されている場合、バックアップは自動的に削除されません。スケジュールから自動的に作成されたクラスタ バックアップの場合、このフィールドには ClusterBackupPlan.RetentionPolicy.backup_retain_days の値が割り当てられます。このフィールドを指定せずに手動で作成されたバックアップの場合、サービスは ClusterBackupPlan.RetentionPolicy.backup_retain_days の値を割り当てます。このフィールドの値が delete_lock_days の値よりも小さいバックアップが作成された場合、サービスは無効な回答を返します。このフィールドは更新リクエストによってのみ増やす必要があります。そうでない場合、サービスから無効な回答が返されます。

BackupScope

バックアップする Namespace とアプリケーションを定義します。

表示場所: - BackupConfig - RestoreConfig

フィールド 説明
allNamespaces ブール値 すべての Namespace がバックアップされるかどうかを指定します。True に設定すると、すべての名前空間をバックアップする必要があることを示します。
selectedNamespaces 名前空間 バックアップする Namespace のリスト。
selectedApplications NamespacedNames バックアップするアプリケーションのリスト。

BackupSpec

バックアップの望ましい状態を定義します。

表示場所: - バックアップ

フィールド 説明
clusterName 文字列 バックアップされるクラスタの名前。デフォルトでは、このバックアップが作成されたクラスタです。
backupPlanName 文字列 このバックアップが作成されたバックアップ プランの名前。
backupConfig BackupConfig このバックアップが指定されたバックアップ プランから生成されるときに使用される構成。これは、参照ではなく、このバックアップが生成されたバックアップ プランからコピーする必要があります。このフィールドはユーザーが設定することはできず、バックアップ プランのスケジューラと ManualBackupRequest リソースのみが設定できます。
description 文字列 バックアップの説明（省略可）。このフィールドは機能に影響しません。
manual ブール値 バックアップ リソースが手動で作成されたかどうかを指定します。True の場合、このバックアップは手動で作成されています。False の場合、このバックアップはバックアップ プランのスケジュールから自動的に作成されています。
deleteLockDays 整数 このバックアップの create_time から削除がブロックされる日数。バックアップ スケジュールから自動的に作成されたバックアップの場合、このフィールドは BackupPlan.RetentionPolicy.backup_delete_block_days の値に設定されます。このフィールドを指定せずに手動で作成されたバックアップの場合、サービスは BackupPlan.RetentionPolicy.backup_delete_block_days の値を割り当てます。このフィールドの値が BackupPlan.RetentionPolicy.backup_delete_block_days の値よりも小さいバックアップが作成されると、サービスから無効な回答が返されます。このフィールドは、0-90 の整数値でなければなりません。このフィールドは更新リクエストによってのみ増やす必要があります。そうでない場合、サービスから無効な回答が返されます。このフィールドは、Succeeded 状態のバックアップにのみ適用されます。デフォルトは 0 です。
retainDays 整数 このバックアップを保持する日数。この日数を過ぎると、バックアップは自動的に削除されます。これはバックアップの create_time から計算されます。このフィールドが指定されていない場合、または 0 に設定されている場合、バックアップは自動的に削除されません。バックアップ スケジュールから自動的に作成されたバックアップの場合、このフィールドには BackupPlan.RetentionPolicy.backup_retain_days の値が割り当てられます。このフィールドを指定せずに手動で作成されたバックアップの場合、サービスは BackupPlan.RetentionPolicy.backup_retain_days の値を割り当てます。このフィールドの値が delete_lock_days の値よりも小さいバックアップが作成された場合、サービスは無効な回答を返します。このフィールドは更新リクエストによってのみ増やす必要があります。そうでない場合、サービスから無効な回答が返されます。デフォルトは 0 です。

BackupStatus

バックアップの観測された状態を定義します。

表示場所: - バックアップ

フィールド 説明
clusterMetadata ClusterMetadata クラスタのメタデータ。
jobCreated ブール値 このバックアップのバックアップ ジョブが作成されたかどうかを指定します。
state BackupState バックアップの現在の状態。
reason 文字列 バックアップが現在の状態である理由に関する説明（人が読める形式）。
errorStatus ErrorStatus 直近のエラーと観測時刻が含まれます。
conditions 条件の配列 conditions は、このバックアップの現在の状態の観測値を表します。既知の条件タイプ: 成功
createTime 時間 このバックアップ リソースが作成されたときのタイムスタンプ。これは RFC 3339 との間で変換できます。
updateTime 時間 このバックアップ プランが最後に更新されたときのタイムスタンプ。これは RFC 3339 との間で変換できます。
resourceCount 整数 バックアップされたリソースの総数。
volumeCount 整数 バックアップされたボリュームの合計数。
sizeBytes 整数 合計サイズ（バイト単位）。
podCount 整数 バックアップされたワークロード Pod の合計数。
systemPodCount 整数 バックアップされたシステム Pod の合計数。これらの Pod は課金対象外です。
vmCount 整数 バックアップされた仮想マシンの合計数。
deleteLockExpireTime 時間 削除ロックの有効期限が切れる時刻。これは、create_time と delete_lock_days の結合値から計算される出力専用フィールドです。バックアップの delete_lock_days フィールドが更新されると、それに応じてこのフィールドも更新されます。このフィールドは、Succeeded 状態のバックアップにのみ適用されます。
retainExpireTime 時間 バックアップが自動的に削除される時刻。これは、create_time と retain_days の結合値から計算される出力専用フィールドです。バックアップの retain_days フィールドが更新されると、それに応じてこのフィールドも更新されます。
completeTime 時間 バックアップの完了時間。

ClusterBackup

表示場所: - ClusterBackupList

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 ClusterBackup
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec ClusterBackupSpec
status ClusterBackupStatus

ClusterBackupConfig

このバックアップ プランからバックアップを作成する構成を定義する内部メッセージ タイプを表します。

表示される場所: - ClusterBackupPlanSpec - ClusterBackupSpec

フィールド 説明
backupScope BackupScope バックアップのリソース選択スコープ。たとえば、all_namespaces、選択した Namespace、選択したアプリケーションなどがあります。backup_scope には 1 つの値を指定する必要があります。BackupScope の値は、BackupConfig_AllNamespaces、BackupConfig_SelectedNamespaces、BackupConfig_SelectedApplications のいずれかの型にする必要があります。
backupRepositoryName 文字列 この ClusterBackupPlan リソースのセカンダリ ストレージを識別する BackupRepositoryRef リソースの名前。
clusterBackupRepositoryName 文字列 この ClusterBackupPlan リソースのセカンダリ ストレージを識別する ClusterBackupRepositoryRef リソースの名前。
includeVolumeData ブール値 ボリューム データがバックアップされるかどうかを指定します。設定しなかった場合、デフォルトは false です。
includeSecrets ブール値 シークレットがバックアップされるかどうかを指定します。設定しなかった場合、デフォルトは false です。
volumeStrategy VolumeStrategy 実行するボリューム バックアップのタイプ。

ClusterBackupList

クラスタ バックアップのリストを表します。

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 ClusterBackupList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items ClusterBackup の配列

ClusterBackupPlan

表示場所: - ClusterBackupPlanList

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 ClusterBackupPlan
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec ClusterBackupPlanSpec
status BackupPlanStatus

ClusterBackupPlanList

ClusterBackup のリストを表します

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 ClusterBackupPlanList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items ClusterBackupPlan 配列

ClusterBackupPlanSpec

backupv1.BackupPlan カスタム リソースをラップする API を表します。ほとんどは同じですが、一部のフィールドは選択的に省略されています。

表示場所: - ClusterBackupPlan

フィールド 説明
targetCluster TargetCluster バックアップされるクラスタ。
backupSchedule スケジュール このバックアップ プランに基づくスケジュールされたバックアップの作成。
clusterBackupConfig ClusterBackupConfig このバックアップ プランのバックアップ構成。
retentionPolicy RetentionPolicy このプランで作成されたバックアップのライフサイクル。
description 文字列 このバックアップ プランについてユーザーが指定した説明文字列。
deactivated ブール値 プランが無効になっているかどうかを指定します。このフィールドを true に設定すると、プランがロックされ、無効化されたフィールドの変更を含め、それ以降の更新は許可されなくなります。また、このプランで新しいバックアップが手動またはスケジュール設定で作成されないようにします。デフォルトは「false」です。

ClusterBackupRepository

ClusterBackupRepository API のスキーマを定義します。

表示場所: - ClusterBackupRepositoryList

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 ClusterBackupRepository
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec ClusterBackupRepositorySpec
status ClusterBackupRepositoryStatus

ClusterBackupRepositoryList

ClusterBackupRepository リソースのリストが含まれます。

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 ClusterBackupRepositoryList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items ClusterBackupRepository 配列

ClusterBackupRepositorySpec

ClusterBackupRepositorySpec リソースの望ましい状態を定義します。

表示場所: - ClusterBackupRepository

フィールド 説明
secretReference SecretReference 選択したストレージ システムに依存するアクセス シークレットへの参照。この Secret は、このエンドポイントへのリクエストで使用されます。たとえば、S3 アクセス シークレットなどです。
endpoint 文字列 クラスタ バックアップ リポジトリへのアクセスに使用されるエンドポイント。
type RepositoryType クラスタ バックアップ リポジトリのタイプ。たとえば、S3 や Google Cloud Storage などです。これにより、使用するストレージ システムまたは API がエージェントに指示されます。
s3Options S3Options S3 互換の BackupRepo リソースへのアクセスを構成するために使用されるデータ。
importPolicy ImportPolicy このバックアップ リポジトリが読み取り専用か読み取り / 書き込みかを決定するポリシー。
force ブール値 初期化されたストレージ バケットが別のバックアップ リポジトリによってすでに要求されている場合に、読み取り / 書き込みバックアップ リポジトリが実行するアクションを指定します。True の場合、新しいバックアップ リポジトリは、既存のセンチネル ファイルを独自のセンチネル ファイルに置き換えることで、ストレージ バケットの所有権を主張します。False の場合、新しいバックアップ リポジトリの作成はエラーで失敗します。デフォルト値は False です。これは、オーバーライドされたセンチネル ファイルにバックアップ リポジトリがなくなった場合にのみ使用する必要があります。そうしないと、バックアップ リポジトリがエラー状態になり、望ましくない副作用が発生する可能性があります。

ClusterBackupRepositoryStatus

ClusterBackupRepository リソースの観測状態を定義します。

表示場所: - ClusterBackupRepository

フィールド 説明
sentinelEtag 文字列 バックアップ リポジトリを所有するセンチネル ファイルに接続するフィールド。
reconciliationError ReconciliationError バックアップ リポジトリの直近の調整試行中に発生したエラー。
reconciliationErrorMessage 文字列 調整中に発生した可能性のあるエラー メッセージ。
errorStatus ErrorStatus 調整の最新のエラーと、観測された時刻が含まれます。
conditions 条件の配列 クラスタ バックアップ リポジトリのステータスを指定します。サポートされている条件は、InitialImportDone、Ready、Deprecated です。

ClusterBackupSpec

backupv1.Backup カスタム リソースをラップする API を表します。ほとんどは同じですが、一部のフィールドは選択的に省略されています。

表示場所: - ClusterBackup

フィールド 説明
targetCluster TargetCluster バックアップされるクラスタの名前。
clusterBackupPlanName 文字列 このバックアップが作成されたクラスタ バックアップ プランの名前。
backupConfig ClusterBackupConfig このバックアップが指定されたバックアップ プランから生成されるときに使用される構成。これは、参照ではなく、このクラスタ バックアップが生成されたクラスタ バックアップ プランからコピーする必要があります。このフィールドはユーザーが設定することはできず、バックアップ プランのスケジューラと ManualBackupRequest リソースのみが設定できます。
description 文字列 バックアップの説明（省略可）。このフィールドは機能に影響しません。
manual ブール値 クラスタ バックアップ リソースが手動で作成されたかどうかを指定します。True の場合、このバックアップは手動で作成されています。False の場合、このクラスタ バックアップはバックアップ プランのスケジュールから自動的に作成されています。
retentionPolicy BackupRetentionPolicy バックアップの保持ポリシー。

ClusterBackupStatus

クラスタ バックアップの観測された状態を定義します。

表示場所: - ClusterBackup

フィールド 説明
clusterMetadata ClusterMetadata クラスタのメタデータ。
conditions 条件の配列 クラスタ バックアップのステータスを指定します。サポートされている条件は JobCreated、Succeeded です。
jobCreated ブール値 このクラスタ バックアップのバックアップ ジョブが作成されたかどうかを指定します。
state BackupState クラスタ バックアップの現在の状態。
stateReason 文字列 バックアップが現在の状態である理由に関する説明（人が読める形式）。
errorStatus ErrorStatus 直近のエラーと観測時刻が含まれます。
createTime 時間 このバックアップ リソースが作成されたときのタイムスタンプ。これは RFC 3339 との間で変換できます。
updateTime 時間 このクラスタ バックアップが最後に更新されたときのタイムスタンプ。これは RFC 3339 との間で変換できます。
resourceCount 整数 バックアップされたリソースの総数。
volumeCount 整数 バックアップされたボリュームの合計数。
sizeBytes 整数 合計サイズ（バイト単位）。
podCount 整数 バックアップされたワークロード Pod の合計数。
deleteLockExpireTime 時間 削除ロックの有効期限が切れる時刻。これは、create_time と delete_lock_days の結合値から計算される出力専用フィールドです。クラスタ バックアップの delete_lock_days フィールドが更新されると、それに応じてこのフィールドも更新されます。このフィールドは、Succeeded 状態のクラスタ バックアップにのみ適用されます。
retainExpireTime 時間 クラスタ バックアップが自動的に削除される時刻。これは、create_time と retain_days の結合値から計算される出力専用フィールドです。クラスタ バックアップの retain_days フィールドが更新されると、それに応じてこのフィールドも更新されます。
completeTime 時間 クラスタ バックアップの完了時間。

ClusterMetadata

クラスタのメタデータを表します。

表示場所: - BackupStatus

フィールド 説明
clusterName 文字列 バックアップが作成されたソースクラスタの名前。
k8sVersion 文字列 Kubernetes サーバーのバージョン。
platformVersion PlatformVersion PlatformVersion に割り当てることができるプラットフォーム バージョン タイプ。例: GpcVersion

ClusterResourceConflictPolicy

基になる型: string 競合が発生した場合に、Namespace が指定されていないクラスタ リソースが従う復元動作。

表示場所: - RestoreConfig - RestorePolicies

ClusterResourceSelection

復元する Namespace なしリソースの選択を表します。

表示場所: - RestoreConfig - RestoreResourceSelection

フィールド 説明
selectedGroupKinds GroupKind の配列 GroupKind リソースのリスト。Namespace なしリソースは、リストで指定された GroupKind リソースの 1 つとして含まれている必要があります。PersistentVolume リソースは名前空間に属していませんが、個別に処理されます。詳しくは、VolumeDataRestorePolicy をご覧ください。このリストで PersistentVolume GroupKind を指定しても、PersistentVolume が復元されるかどうかに影響はありません。

ClusterRestore

ClusterRestore API のスキーマを定義します。

表示場所: - ClusterRestoreList

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 ClusterRestore
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec ClusterRestoreSpec
status ClusterRestoreStatus

ClusterRestoreConfig

ClusterRestore の構成を定義します。

表示場所: - ClusterRestorePlanSpec - ClusterRestoreSpec

フィールド 説明
volumeDataRestorePolicy VolumeDataRestorePolicy ボリューム データの復元に使用するポリシー。値が指定されていない場合、デフォルト値の NO_VOLUME_DATA_RESTORATION を提供します。
clusterResourceConflictPolicy ClusterResourceConflictPolicy クラスタ スコープのリソースを復元するときに競合を解決するポリシー。このフィールドの値が CLUSTER_RESOURCE_CONFLICT_POLICY_UNSPECIFIED で、cluster_resource_restore_scope が指定されている場合、このリクエストは無効です。
namespacedResourceRestoreMode NamespacedResourceRestoreMode Namespace リソースに使用する復元モード。このフィールドの値が NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED で、namespaced_resource_restore_scope が指定されている場合、リクエストは無効です。
clusterResources ClusterResourceSelection 復元する名前空間なしリソース。このフィールドが指定されていない場合、クラスタ リソースは復元されません。PersistentVolume リソースは名前空間に属していませんが、個別に処理されます。詳細については、VolumeDataRestorePolicy リソースをご覧ください。このリストで PersistentVolume GroupKind を指定しても、PersistentVolume が復元されるかどうかは決まりません。
namespacedResourceAllowlist GroupKind の配列 復元する特定の Namespace 付きリソース。定義されている場合、この allowlist で定義されているリソースのみが復元されます。
namespacedResourceRestoreScope BackupScope 復元する選択された Namespace リソース。エントリのいずれかを有効な Type とともに指定する必要があります。restoreScope に割り当てることができる Type の有効な値は、AllNamespaces、SelectedNamespaces、SelectedApplications です。
substitutionRules SubstitutionRule 配列 バックアップされた Kubernetes リソースの置換時に適用されるルール。リストが空の場合、置換は行われません。置換ルールは、定義された順序で順番に適用されます。ルールによる変更が後続のルールの照合ロジックに影響する可能性があるため、この順序は重要です。特定の復元オペレーションに指定できるのは、SubstitutionRules または TransformationRules のいずれか 1 つだけです。
transformationRules TransformationRule の配列 バックアップされた Kubernetes リソースの変換時に適用されるルール。リストが空の場合、変換は行われません。変換ルールは、定義された順序で順番に適用されます。ルールによる変更が後続のルールの照合ロジックに影響する可能性があるため、この順序は重要です。特定の復元オペレーションに指定できるのは、SubstitutionRules または TransformationRules のいずれか 1 つだけです。
clusterBackupRepositoryRef 文字列 復元リソースのリポジトリを識別するクラスタ バックアップ リポジトリの名前。このフィールドは読み取り / 書き込みモードでアタッチする必要があります。このフィールドが指定されていない場合は、次のロジックを使用して選択されます。1. 復元を実行するバックアップが現在のクラスタの読み取り / 書き込みリポジトリを指している場合、このリポジトリが選択されます。2. 復元を実行するバックアップが読み取り専用リポジトリを指している場合、クラスタの読み取り / 書き込みリポジトリが選択されて使用されます。

ClusterRestoreList

クラスタ復元のリストを表します。

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 ClusterRestoreList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items ClusterRestore 配列

ClusterRestorePlan

ClusterRestorePlan API のスキーマを定義します。

表示場所: - ClusterRestorePlanList

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 ClusterRestorePlan
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec ClusterRestorePlanSpec
status RestorePlanStatus

ClusterRestorePlanList

ClusterRestorePlan リソースのリストを表します。

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 ClusterRestorePlanList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items ClusterRestorePlan 配列

ClusterRestorePlanSpec

backupv1.RestorePlan カスタム リソースをラップする API を表します。ほとんどは同じですが、一部のフィールドは選択的に省略されています。ClusterRestorePlan の望ましい状態を定義します。

表示場所: - ClusterRestorePlan

フィールド 説明
targetCluster TargetCluster データが復元されるクラスタ。
clusterBackupPlanName 文字列 この ClusterRestorePlan を使用して作成されたクラスタ復元のソースとしてクラスタ バックアップを使用できるクラスタ バックアップ プランの名前。このフィールドは必須で、変更できません。
clusterRestoreConfig ClusterRestoreConfig このクラスタ復元プランのクラスタ復元構成。
description 文字列 このクラスタ復元プランについてユーザーが指定した説明的な文字列。

ClusterRestoreSpec

backupv1.Restore カスタム リソースをラップする API を表します。ClusterRestore の望ましい状態を定義します。

表示場所: - ClusterRestore

フィールド 説明
targetCluster TargetCluster データが復元されるクラスタ。
clusterBackupName 文字列 クラスタ バックアップの名前。クラスタ復元と同じ Namespace に存在する必要があります。
clusterRestorePlanName 文字列 このクラスタ復元が ClusterRestoreConfig リソースを継承したクラスタ復元プランの名前。
clusterRestoreConfig ClusterRestoreConfig クラスタ復元の構成。
description 文字列 クラスタの復元の説明（省略可）。機能には影響しません。
filter フィルタ フィルタを使用すると、ClusterRestorePlan で定義された大まかなスコープを超えて、クラスタ復元のリソース選択をさらに絞り込むことができます。

ClusterRestoreStatus

クラスタの復元の観測された状態を定義します。

表示場所: - ClusterRestore

フィールド 説明
conditions 条件の配列 クラスタの復元のステータスを指定します。サポートされている条件は JobCreated、Succeeded です。
state RestoreState クラスタ復元の現在の状態。
stateReason 文字列 クラスタの復元が現在の状態である理由に関する説明（人が読める形式）。
errorStatus ErrorStatus 直近のエラーと観測時刻が含まれます。
resourcesRestoredCount 整数 このクラスタ復元アクションで復元されたリソースの数。
resourcesExcludedCount 整数 このクラスタ復元アクションで除外されたリソースの数。
resourcesFailedCount 整数 このクラスタ復元アクションで復元できなかったリソースの数。
restoredVolumesCount 整数 このクラスタ復元アクションで復元されたボリュームの数。
startTime 時間 クラスタ復元プロセスの作成時間。
completeTime 時間 クラスタの復元プロセスの終了時刻。

ClusterStatus

ClusterStatus には、特定のクラスタのバックアップ リポジトリの作成ステータスが含まれます。

表示場所: - BackupRepositoryManagerStatus

フィールド 説明
cluster NamespacedName
conditions 条件の配列

ClusterVolumeBackup

ClusterVolumeBackup API のスキーマを定義します。

表示場所: - ClusterVolumeBackupList

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 ClusterVolumeBackup
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec ClusterVolumeBackupSpec
status ClusterVolumeBackupStatus

ClusterVolumeBackupList

ClusterVolumeBackup リソースのリストが含まれます。

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 ClusterVolumeBackupList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items ClusterVolumeBackup 配列

ClusterVolumeBackupSpec

クラスタ ボリューム バックアップの望ましい状態を定義します。

表示場所: - ClusterVolumeBackup

フィールド 説明
cluster TargetCluster このクラスタ ボリューム バックアップがデータを保持するクラスタの名前。
clusterBackupName 文字列 関連付けられているバックアップの名前。各クラスタ ボリューム バックアップは、バックアップに関連付ける必要があります。常に同じ Namespace に存在します。
clusterBackupPlanName 文字列 関連付けられたバックアップが作成されたバックアップ プランの名前。常に同じ Namespace に存在します。
sourcePVC TypedObjectReference クラスタ ボリュームのバックアップの取得元となるソースの永続ボリュームのクレーム。

ClusterVolumeBackupStatus

クラスタ ボリューム バックアップの観測された状態を定義します。

表示場所: - ClusterVolumeBackup

フィールド 説明
volumeBackupHandle 文字列 基盤となるクラスタ ボリューム バックアップ ハンドル。バックアップ リポジトリ内のクラスタ ボリューム バックアップを一意に識別します。このハンドルには統一された形式がなく、不透明な文字列として扱われます。
format VolumeBackupFormat クラスタ ボリュームのバックアップ形式。（PD、Portable など）。
storageBytes 整数 バックアップ ストレージ内のクラスタ ボリューム バックアップのサイズ。増分バックアップの場合、以前のボリューム バックアップのいずれかが削除されると、この値は動的に変更されることがあります。
diskSizeBytes 整数 このボリューム バックアップを復元できるディスクの最小サイズ。
state VolumeBackupState ボリューム バックアップの現在の状態。
message 文字列 バックアップがこの状態にある理由の詳細を示す、人間が読めるメッセージ。
completeTime 時間 この ClusterVolumeBackup リソースが完了したときのタイムスタンプ（RFC 3339 のテキスト形式）。
conditions 条件の配列 クラスタ ボリューム バックアップのステータスを指定します。

ClusterVolumeRestore

backupv1.VolumeRestore カスタム リソースをラップする API を表します。ClusterVolumeRestore API のスキーマを定義します。

表示場所: - ClusterVolumeRestoreList

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 ClusterVolumeRestore
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec ClusterVolumeRestoreSpec
status VolumeRestoreStatus

ClusterVolumeRestoreList

ClusterVolumeRestore リソースのリストを表します。

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 ClusterVolumeRestoreList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items ClusterVolumeRestore 配列

ClusterVolumeRestoreSpec

クラスタ ボリュームの復元の望ましい状態を定義します。

表示場所: - ClusterVolumeRestore

フィールド 説明
targetCluster TargetCluster ボリュームが復元されるクラスタの名前。
clusterRestoreName 文字列 このクラスタ ボリュームの復元を作成したクラスタ復元リソースの名前。
clusterVolumeBackupName 文字列 復元するクラスタ ボリューム バックアップ リソースの名前。
targetPvc NamespacedName 復元するターゲット PersistentVolumeClaim リソース。

DeleteBackupRequest

DeleteBackupRequest API のスキーマを定義します。

表示場所: - DeleteBackupRequestList

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 DeleteBackupRequest
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec DeleteBackupRequestSpec
status DeleteBackupRequestStatus

DeleteBackupRequestList

DeleteBackupRequest リソースのリストが含まれます。

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 DeleteBackupRequestList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items DeleteBackupRequest 配列

DeleteBackupRequestSpec

DeleteBackupRequest リソースの望ましい状態を定義します。

表示場所: - DeleteBackupRequest

フィールド 説明
backupName 文字列 削除するバックアップの名前。バックアップは、DeleteBackupRequest リソースと同じ Namespace に存在する必要があります。

DeleteBackupRequestStatus

DeleteBackupRequest リソースの観測状態を定義します。

表示場所: - DeleteBackupRequest

フィールド 説明
timeToExpire 時間 リソースの有効期限。
statusField StatusFields DeleteBackupRequest リソースの観測された状態のステータス。

DeleteClusterBackupRequest

DeleteClusterBackupRequest API のスキーマを定義します。

表示場所: - DeleteClusterBackupRequestList

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 DeleteClusterBackupRequest
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec DeleteClusterBackupRequestSpec
status DeleteClusterBackupRequestStatus

DeleteClusterBackupRequestList

DeleteBackupRequest リソースのリストが含まれます。

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 DeleteClusterBackupRequestList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items DeleteClusterBackupRequest 配列

DeleteClusterBackupRequestSpec

DeleteClusterBackupRequest リソースの望ましい状態を定義します。

表示場所: - DeleteClusterBackupRequest

フィールド 説明
clusterBackupRef 文字列 削除する ClusterBackup リソースの名前。ClusterBackup リソースは、DeleteClusterBackupRequest リソースと同じ Namespace に存在している必要があります。

DeleteClusterBackupRequestStatus

DeleteClusterBackupRequest リソースの観測状態を定義します。

表示場所: - DeleteClusterBackupRequest

フィールド 説明
timeToExpire 時間 リソースの有効期限。
statusField StatusFields DeleteClusterBackupRequest リソースの観測された状態のステータス。

EncryptionKey

暗号鍵を定義します。プレビュー版では、Google Cloud Platform KMS のみがサポートされています。

表示場所: - BackupConfig - RestoreConfig

フィールド 説明
gcpKMSEncryptionKey 文字列 Google KMS 暗号鍵。形式は projects/<project>/locations/<location>/keyRings/<key-ring>/cryptoKeys/<key> です。

フィルタ

きめ細かい復元フィルタを定義します

表示場所: - ManualRestoreRequestSpec - RestoreSpec

フィールド 説明
inclusionFilters ResourceSelector の配列 復元するリソースを選択します。指定した場合、inclusion_filters に一致するリソースのみが復元対象として選択されます。リソースは、inclusion_filters の ResourceSelector のいずれかに一致する場合に選択されます。
exclusionFilters ResourceSelector の配列 復元からリソースを除外します。指定した場合、リソースが exclusion_filters の ResourceSelector と一致すると、リソースは復元されません。

ImportPolicy

基盤となる型: string このバックアップ リポジトリが読み取り専用か読み取り / 書き込みかを決定するポリシー。

表示場所: - BackupRepositorySpec

ImportSubstitution

インポートされたリソースでバックアップ リポジトリ名を置き換えるかどうかを表します。

表示場所: - BackupRepositorySpec

フィールド 説明
substituteBRName ブール値

ManualBackupRequest

ManualBackupRequest API のスキーマを定義します。

表示場所: - ManualBackupRequestList

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 ManualBackupRequest
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec ManualBackupRequestSpec
status ManualBackupRequestStatus

ManualBackupRequestList

ManualBackupRequest リソースのリストが含まれます。

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 ManualBackupRequestList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items ManualBackupRequest の配列

ManualBackupRequestSpec

ManualBackupRequest リソースの望ましい状態を定義します。

表示場所: - ManualBackupRequest

フィールド 説明
backupName 文字列 作成する手動バックアップの名前。
backupPlanName 文字列 BackupConfig リソースが取得されるバックアップ プランの名前。
description 文字列 この ManualBackupRequest リソースによって作成されたバックアップについて、ユーザーが指定した説明文字列。
deleteLockDays 整数 このバックアップの create_time から削除がブロックされる日数。スケジュールから自動的に作成されたバックアップの場合、このフィールドには BackupPlan.RetentionPolicy.backup_delete_block_days の値が設定されます。このフィールドを指定せずにバックアップを作成すると、値 BackupPlan.RetentionPolicy.backup_delete_block_days が割り当てられます。このバックアップが BackupPlan.RetentionPolicy.backup_delete_block_days の値よりも小さい値に設定されたこのフィールドで作成された場合、エージェントから無効な回答が返されます。このフィールドは 0-90 内の値である必要があります。このフィールドは更新リクエストによってのみ増やす必要があります。そうでない場合、エージェントから無効な回答が返されます。このフィールドは、Succeeded 状態のバックアップにのみ適用されます。デフォルトは 0 です。
retainDays 整数 このバックアップを保持する日数。この日数を過ぎると、バックアップは自動的に削除されます。このフィールドが指定されていない場合、または 0 に設定されている場合、バックアップは自動的に削除されません。バックアップ スケジュールから自動的に作成されたバックアップの場合、このフィールドには BackupPlan.RetentionPolicy.backup_default_retain_days の値が割り当てられます。このフィールドが指定されていない作成済みバックアップの場合、エージェントは BackupPlan.RetentionPolicy.backup_default_retain_days の値を使用します。このフィールドを delete_lock_days より小さい値に設定してバックアップを作成すると、エージェントから無効な回答が返されます。このフィールドは更新リクエストでのみ増やす必要があります。そうしないと、エージェントから無効な回答がすぐに返されます。デフォルトは 0 です。

ManualBackupRequestStatus

ManualBackupRequest リソースの観測状態を定義します。

表示場所: - ManualBackupRequest

フィールド 説明
timeToExpire 時間 リソースの有効期限が切れる時刻。
statusField StatusFields ManualBackupRequest リソースの観測された状態のステータス。
statusMessage 文字列 statusMessage は、ManualBackupRequest リソースのエラー メッセージです。

ManualClusterBackupRequest

ManualClusterBackupRequest API のスキーマを定義します。

表示場所: - ManualClusterBackupRequestList

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 ManualClusterBackupRequest
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec ManualClusterBackupRequestSpec
status ManualClusterBackupRequestStatus

ManualClusterBackupRequestList

ManualClusterBackupRequest リソースのリストが含まれます。

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 ManualClusterBackupRequestList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items ManualClusterBackupRequest 配列

ManualClusterBackupRequestSpec

ManualClusterBackupRequest リソースの望ましい状態を定義します。

表示場所: - ManualClusterBackupRequest

フィールド 説明
clusterBackupName 文字列 作成するクラスタ バックアップの名前。これは、ManualClusterBackupRequest リソースと同じ Namespace 内に作成されます。
clusterBackupPlanRef 文字列 ClusterBackupConfig リソースが取得されるクラスタ バックアップ プランの名前。クラスタ バックアップ プランは、ManualClusterBackupRequest リソースと同じ Namespace に存在することが想定されています。
description 文字列 この ManualClusterBackupRequest リソースによって作成されたクラスタ バックアップのユーザー指定の説明文字列。
deleteLockDays 整数 このバックアップの create_time から削除がブロックされる日数。スケジュールから自動的に作成されたバックアップの場合、このフィールドには BackupPlan.RetentionPolicy.backup_delete_block_days の値が設定されます。このフィールドを指定せずに Backup が作成された場合、値 BackupPlan.RetentionPolicy.backup_delete_block_days が割り当てられます。この Backup がこのフィールドを ClusterBackupPlan.RetentionPolicy.backup_delete_block_days の値より小さい値に設定して作成された場合、エージェントから無効な回答が返されます。このフィールドは 0-90 内の値である必要があります。このフィールドは更新リクエストによってのみ増やす必要があります。そうでない場合、エージェントから無効な回答が返されます。このフィールドは、Succeeded 状態のバックアップにのみ適用されます。
retainDays 整数 このバックアップを保持する日数。この日数を過ぎると、バックアップは自動的に削除されます。このフィールドが指定されていない場合、または 0 に設定されている場合、バックアップは自動的に削除されません。バックアップ スケジュールから自動的に作成されたバックアップの場合、このフィールドには BackupPlan.RetentionPolicy.backup_default_retain_days の値が割り当てられます。このフィールドを未指定のまま作成されたバックアップの場合、エージェントは ClusterBackupPlan.RetentionPolicy.backup_default_retain_days の値を使用します。このフィールドを delete_lock_days より小さい値に設定してバックアップを作成すると、エージェントから無効な回答が返されます。このフィールドは更新リクエストでのみ増やす必要があります。そうしないと、エージェントから無効な回答がすぐに返されます。

ManualClusterBackupRequestStatus

ManualClusterBackupRequest リソースの観測状態を定義します。

表示場所: - ManualClusterBackupRequest

フィールド 説明
timeToExpire 時間 リソースの有効期限。
statusField StatusFields ManualClusterBackupRequest リソースの観測された状態のステータス。

ManualClusterRestoreRequest

ManualClusterRestoreRequest API のスキーマを定義します。

表示場所: - ManualClusterRestoreRequestList

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 ManualClusterRestoreRequest
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec ManualClusterRestoreRequestSpec
status ManualRestoreRequestStatus

ManualClusterRestoreRequestList

ManualClusterRestoreRequest リソースのリストを表します。

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 ManualClusterRestoreRequestList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items ManualClusterRestoreRequest 配列

ManualClusterRestoreRequestSpec

ManualClusterRestoreRequest リソースの望ましい状態を定義します。

表示場所: - ManualClusterRestoreRequest

フィールド 説明
clusterRestoreName 文字列 作成するクラスタ復元の名前。
clusterRestorePlanName 文字列 ClusterRestoreConfig リソースの取得元となるクラスタ復元プランの名前。
clusterBackupName 文字列 復元中のクラスタ バックアップの名前。クラスタ復元プランとクラスタ バックアップは、ManualClusterRestoreRequest リソースと同じ Namespace に存在することが想定されています。
description 文字列 この ManualClusterRestoreRequest リソースによって作成されたクラスタ復元についてユーザーが指定した説明的な文字列。
filter フィルタ ClusterRestorePlan で定義された大まかなスコープを超えて、クラスタ復元のリソース選択をさらに絞り込むために使用できるフィルタ。

ManualRestoreRequest

ManualRestoreRequest API のスキーマを定義します。

表示場所: - ManualRestoreRequestList

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 ManualRestoreRequest
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec ManualRestoreRequestSpec
status ManualRestoreRequestStatus

ManualRestoreRequestList

ManualRestoreRequest リソースのリストが含まれます。

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 ManualRestoreRequestList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items ManualRestoreRequest 配列

ManualRestoreRequestSpec

ManualRestoreRequest リソースの望ましい状態を定義します。

表示場所: - ManualRestoreRequest

フィールド 説明
restoreName 文字列 作成する手動復元の名前。
restorePlanName 文字列 RestoreConfig リソースの取得元となる復元プランの名前。
backupName 文字列 復元中のバックアップの名前。
description 文字列 この ManualRestoreRequest リソースによって作成された復元についてユーザーが指定した説明的な文字列。
filter フィルタ RestorePlan で定義された大まかなスコープを超えて、Restore のリソース選択をさらに絞り込むために使用できるフィルタ。

ManualRestoreRequestStatus

ManualRestoreRequest リソースの観測状態を定義します。

表示場所: - ManualRestoreRequest

フィールド 説明
timeToExpire 時間 リソースの有効期限が切れる時刻。
statusField StatusFields ManualRestoreRequest リソースの観測された状態のステータス。

NamespacedName

特定の名前空間で名前を定義します。

表示場所: - NamespacedNames - NamespacedResourceSelection - VolumeBackupSpec - VolumeRestoreSpec

フィールド 説明
namespace 文字列 Kubernetes のリソースの Namespace。
name 文字列 Kubernetes のリソースの名前。

NamespacedNames

表示場所: - BackupScope

フィールド 説明
namespacedNames NamespacedName 配列 Namespace 名のリスト。

NamespacedResourceRestoreMode

基になるタイプ: string 名前空間付きリソースの復元動作。

表示場所: - RestoreConfig - RestorePolicies

NamespacedResourceSelection

復元する Namespace 付きリソースの選択を定義します。次のいずれかの値を、一致する Type とともに指定する必要があります。

`AllNamespaces`, `SelectedNamespaces`, or `SelectedApplications`.

表示場所: - RestoreResourceSelection

フィールド 説明
type NamespacedResourceSelectionType 使用する選択のタイプ。
allNamespaces ブール値 バックアップ内のすべての名前空間付きリソースを復元するかどうかを指定します。このフィールドを未指定のままにするか、Type を NamespacedResourceSelectionType.AllNamespaces に設定した状態で False に設定することは無効です。
selectedNamespaces 文字列配列 復元する選択された Namespace のリスト。Type が NamespacedResourceSelectionType.SelectedNamespaces に設定されている状態で値が指定されている場合、指定されたリストに含まれる元の Namespace を持つリソースが復元されます。このリストに空の文字列を指定しても、名前空間のないクラスタ リソースは復元されません。クラスタ リソースを復元するには、ClusterResourceSelection をご覧ください。
selectedApplications NamespacedName 配列 復元する ProtectedApplication リソースのリスト。値が指定され、Type が NamespacedResourceSelectionType.SelectedApplications に設定されている場合、リストに記載されているアプリケーションのいずれかに属するリソースが復元されます。

NamespacedResourceSelectionType

基盤となるタイプ: string 名前空間リソースの選択のタイプ。

表示場所: - NamespacedResourceSelection

名前空間

表示場所: - BackupScope

フィールド 説明
namespaces 文字列配列 Namespace のリスト。

ObjectStorageBackupConfig

オブジェクト ストレージのバックアップを構成します。

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 ObjectStorageBackupConfig
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
source ObjectStorageEndpoint バックアップするソース オブジェクト ストレージ。
target ObjectStorageEndpoint バックアップの書き込み先。
timestamp ブール値 各転送をバケットのタイムスタンプ付きサブパスに保存するかどうかを指定します。True に設定されている場合、構造は YYYY-MM-DD-hh:mm:ss です。これにより、バックアップの複数の特定の時点から取得したコピーを保存できます。デフォルトは False です。

ObjectStorageEndpoint

オブジェクト ストレージ エンドポイントと、それにアクセスするための認証情報を表します。

表示場所: - ObjectStorageBackupConfig

フィールド 説明
endpoint 文字列 オブジェクト ストレージへのアクセスに使用されるエンドポイント。例: https://s3.svc
bucket 文字列 スコープ参照するエンドポイント内のバケット。
secretReference SecretReference オブジェクト ストレージへのアクセスに使用される S3 アクセス認証情報の参照。

PlatformVersion

プラットフォームのバージョンを定義します。

表示場所: - ClusterMetadata

フィールド 説明
gpcVersion 文字列 Google Private Cloud のバージョン。

ReconciliationError

基盤となるタイプ: string バックアップ リポジトリの最新の調整試行中に発生したエラー。

表示場所: - BackupRepositoryStatus

RepositoryType

基になる型: string 書き込み先のエンドポイントの型。

表示場所: - BackupRepositorySpec

ResourceFilter

候補リソースのリストをフィルタして、変換ルールを提供するルールを定義します。ResourceFilter を含むすべてのフィールドは省略可能です。そのため、ResourceFilter フィールドを指定しないと、すべてのリソースが一致します。

表示場所: - TransformationRule

フィールド 説明
namespaces 文字列配列 変換ルールが適用されるターゲット Namespace のリスト。リソースの元の Namespace がリスト内の名前のいずれかと一致する場合、変換候補と見なされます。名前空間が指定されていないリソースを考慮するには、リストに空の文字列が必要です。空の場合、すべての名前空間が考慮されます。
groupKinds GroupKind の配列 変換ルールが適用されるターゲット GroupKind リソースのリスト。リソースの元の GroupKind リソースは、リストで指定された GroupKind リソースのいずれかと一致する必要があります。一致しない場合、変換候補と見なされません。空の場合、すべての GroupKind リソースが考慮されます。リソースが変換候補と見なされるには、Namespaces 要件と GroupKinds 要件の両方を満たす必要があります。
jsonPath 文字列 フィルタリングするターゲット リソースのフィールドにつながる JSON 内のパスの文字列表現。JSONPath のドキュメントは、https://github.com/json-path/JsonPath/blob/master/README.md でご覧いただけます。JSONPath の形式は、オンラインでテストできます（https://jsonpath.com/ など）。

ResourceSelector

きめ細かい復元フィルタの ResourceSelector を定義します

表示場所: - フィルタ

フィールド 説明
groupKind GroupKind Kubernetes GroupKind を使用してリソースを選択します。指定した場合、指定された GroupKind のリソースのみが選択されます。
name 文字列 リソース名を使用してリソースを選択します。指定した場合、指定された名前のリソースのみが選択されます。
namespace 文字列 Namespace を使用してリソースを選択します。これは Namespace スコープのリソースにのみ適用され、クラスタ スコープのリソースの選択には使用できません。指定した場合、指定された Namespace のリソースのみが選択されます。指定しない場合、フィルタはクラスタ スコープと Namespace スコープの両方のリソース（名前やラベルなど）に適用されます。Namespace 内のリソースが復元された場合にのみ、Namespace リソース自体が復元されます。
labels オブジェクト（キー:文字列、値:文字列） Kubernetes ラベルを使用してリソースを選択します。指定した場合、リソースに指定されたすべてのラベルがあり、すべてのラベル値が一致する場合にのみ、リソースが選択されます。

復元

Restore API のスキーマを定義します。

表示場所: - RestoreList

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 Restore
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec RestoreSpec
status RestoreStatus

RestoreConfig

復元の構成を定義します。

表示場所: - RestorePlanSpec - RestoreSpec

フィールド 説明
volumeDataRestorePolicy VolumeDataRestorePolicy ボリューム データの復元に使用するポリシー。値が指定されていない場合、デフォルト値の NO_VOLUME_DATA_RESTORATION を提供します。
clusterResourceConflictPolicy ClusterResourceConflictPolicy クラスタ スコープのリソースを復元するときに競合を解決するポリシー。このフィールドが指定されていない場合、リクエストは無効になります。このフィールドの値が CLUSTER_RESOURCE_CONFLICT_POLICY_UNSPECIFIED で、cluster_resource_restore_scope が指定されている場合、このリクエストは無効です。
namespacedResourceRestoreMode NamespacedResourceRestoreMode Namespace リソースに使用する復元モード。このフィールドが指定されていない場合、リクエストは無効になります。このフィールドの値が NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED で、namespaced_resource_restore_scope が指定されている場合、リクエストは無効です。
clusterResources ClusterResourceSelection 復元する名前空間なしリソース。このフィールドが指定されていない場合、クラスタ リソースは復元されません。PersistentVolume リソースは名前空間に属していませんが、個別に処理されます。詳細については、VolumeDataRestorePolicy リソースをご覧ください。このリストで PersistentVolume GroupKind を指定しても、PersistentVolume が復元されるかどうかは決まりません。
namespacedResourceAllowlist GroupKind の配列 復元する特定の Namespace 付きリソース。定義されている場合、この allowlist で定義されているリソースのみが復元されます。
restoreScope BackupScope 復元する選択された Namespace リソース。エントリのいずれかを有効な Type とともに指定する必要があります。restoreScope に割り当てることができる Type の有効な値は、AllNamespaces、SelectedNamespaces、SelectedApplications です。
substitutionRules SubstitutionRule 配列 バックアップされた Kubernetes リソースの置換時に適用されるルール。リストが空の場合、置換は行われません。置換ルールは、定義された順序で順番に適用されます。ルールによる変更が後続のルールの照合ロジックに影響する可能性があるため、この順序は重要です。特定の復元オペレーションに指定できるのは、SubstitutionRules または TransformationRules のいずれか 1 つだけです。
transformationRules TransformationRule の配列 バックアップされた Kubernetes リソースの変換時に適用されるルール。リストが空の場合、変換は行われません。変換ルールは、定義された順序で順番に適用されます。ルールによる変更が後続のルールの照合ロジックに影響する可能性があるため、この順序は重要です。特定の復元オペレーションに指定できるのは、SubstitutionRules または TransformationRules のいずれか 1 つだけです。
backupRepository 文字列 復元リソースのリポジトリを識別するバックアップ リポジトリの名前。このフィールドは読み取り / 書き込みモードでアタッチする必要があります。このバックアップ リポジトリは、この復元が参照するバックアップのバックアップ リポジトリと異なる場合があります。このフィールドが指定されていない場合は、次のロジックを使用して選択されます。1. 復元を実行するバックアップが現在のクラスタの読み取り / 書き込みリポジトリを指している場合、このリポジトリが選択されます。2. 復元を実行するバックアップが読み取り専用リポジトリを指している場合、クラスタの読み取り / 書き込みリポジトリが選択されて使用されます。
encryptionKey EncryptionKey 暗号鍵。このフィールドは変更できません。

RestoreList

Restore リソースのリストが含まれます。

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 RestoreList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items 復元の配列

RestorePlan

RestorePlan API のスキーマを定義します。

表示場所: - RestorePlanList

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 RestorePlan
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec RestorePlanSpec
status RestorePlanStatus

RestorePlanList

RestorePlan リソースのリストが含まれます。

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 RestorePlanList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items RestorePlan 配列

RestorePlanSpec

復元プランの望ましい状態を定義します。

表示場所: - RestorePlan

フィールド 説明
backupPlanName 文字列 この復元プランを使用して作成された復元のソースとしてバックアップを使用できるバックアップ プランの名前。このフィールドは必須で、変更できません。
restoreConfig RestoreConfig この復元プランの復元構成。
clusterName 文字列 この復元プランで復元されるデータを含むクラスタの名前。デフォルトでは、復元プランが作成されたクラスタです。
description 文字列 この復元プランについてユーザーが指定した説明的な文字列。

RestorePlanStatus

復元プランの観測状態を定義します。

表示場所: - RestorePlan

フィールド 説明
lastRestoreTime 時間 最後に実行された復元のタイムスタンプ。
state StatusFields 復元プランの現在の状態。

RestoreSpec

復元の望ましい状態を定義します。

表示場所: - 復元

フィールド 説明
backupName 文字列 この Restore リソースが復元に使用するバックアップ リソースの完全な名前。
restorePlanName 文字列 この復元が RestoreConfig リソースを継承した復元プランの名前。
clusterName 文字列 この復元によって復元されたデータを含むクラスタの名前。デフォルトでは、復元が作成されたクラスタです。
restoreConfig RestoreConfig 復元の構成。
description 文字列 バックアップの説明（省略可）。機能には影響しません。
filter フィルタ フィルタを使用すると、RestorePlan で定義された大まかなスコープを超えて、Restore のリソース選択をさらに絞り込むことができます。

RestoreState

基になる型: string

表示場所: - RestoreStatus

RestoreStatus

復元の観測された状態を定義します。

表示場所: - 復元

フィールド 説明
state RestoreState 復元の現在の状態。
stateReason 文字列 復元が現在の状態である理由に関する説明（人が読める形式）。
errorStatus ErrorStatus 直近のエラーと観測時刻が含まれます。
conditions 条件の配列 conditions は、この復元の現在の状態の観測値を表します。既知の条件タイプ: 成功
jobCreated ブール値 この復元に対して復元ジョブが作成されたかどうかを指定します。
resourcesRestoredCount 整数 この復元アクションで復元されたリソースの数。
resourcesExcludedCount 整数 この復元アクションで除外されたリソースの数。
resourcesFailedCount 整数 この復元アクションで復元できなかったリソースの数。
restoredVolumesCount 整数 この復元アクションで復元されたボリュームの数。
startTime 時間 復元プロセスの作成時間。
completeTime 時間 復元プロセスの終了時間。

RetentionPolicy

このバックアップ プランで作成されたバックアップを自動的に削除するタイミングを決定するポリシー、プランレベルのバックアップ保持日数の最小数、保持するバックアップのプランレベルの最小数、ポリシーの更新を禁止するロックを定義します。

表示場所: - BackupPlanSpec

フィールド 説明
backupDeleteLockDays 整数 このバックアップ プランで作成されたバックアップの削除がブロックされる日数。デフォルトは 0 です。このフィールドは、0-90 の整数値でなければなりません。このバックアップ プランで作成されたバックアップは、バックアップの create_time と backup_delete_lock_days の合計値に達するまで削除できません。このバックアップ プラン フィールドを更新しても、その下にある既存のバックアップには影響しません。更新が成功した後に作成されたバックアップは、新しい値を自動的に継承します。
backupRetainDays 整数 サービスがバックアップを削除するまでの日数。指定した場合、このバックアップ プランで作成されたバックアップは、create_time と backup_retain_days の合計値に達すると自動的に削除されます。指定しない場合、このバックアップ プランで作成されたバックアップは自動的に削除されません。このフィールドを更新しても、その下の既存のバックアップには影響しません。更新が成功した後に作成されたバックアップは、新しい値を自動的に継承します。注釈: 作成または更新時に backup_retain_days に backup_delete_lock_days より小さい値を指定すると、無効とみなされ、リクエストは直ちに拒否されます。
locked ブール値 このバックアップ プランの保持ポリシーがロックされているかどうかを指定します。True に設定すると、locked フィールド自体を含め、このポリシーの更新ができなくなります。デフォルトは False です。
numBackupsToRetain 整数 保持するバックアップの数。指定した場合、create_time と backup_delete_lock_days are automatically deleted after the total number of backups under this backup plan reaches the value ofnum_backups_to_retain` の合計値に達したバックアップ プランの最も古いバックアップ。指定しない場合、このバックアップ プランで作成されたバックアップは、'backup_retain_days' に基づいて自動的に削除される場合とされない場合があります。このフィールドを更新すると、バックアップ プランの下にある既存のバックアップに影響します。num_backups_to_retain は、backup_delete_lock_days 内で作成できるバックアップの数以上にする必要があります。

S3Options

バックアップ リポジトリの S3 エンドポイントを呼び出すためのオプションを定義します。

表示場所: - BackupRepositorySpec

フィールド 説明
bucket 文字列 バックアップをアップロードするエンドポイント内のバケット。
region 文字列 指定されたエンドポイントのリージョン。フォーマットはストレージ システムによって異なります。
forcePathStyle ブール値 オブジェクトのパス スタイル URL を強制するかどうかを指定します。たとえば、https://.s3.amazonaws.com/ ではなく https://s3.amazonaws.com// となっている場合などです。
serverSideEncryption 文字列 オブジェクトの保存時に使用されるサーバーサイド暗号化アルゴリズム。たとえば、AES256 oraws:kms` などです。
kmsKeyId 文字列 サーバーサイドの暗号化で KMS を使用している場合に、オブジェクト ストレージで使用する KMS 鍵 ID。

スケジュール

cron スケジュールを定義する内部メッセージ タイプを表します。

表示場所: - BackupPlanSpec

フィールド 説明
cronSchedule 文字列 オペレーションが実行される cron 文字列スケジュール。
paused ブール値 スケジュールされたオペレーションが非アクティブかアクティブかを指定します。True に設定すると、スケジュールされたオペレーションは非アクティブになります。デフォルトは True です。
maxConcurrency 整数 バックアップ プランで同時に存在できるアクティブなスケジュール設定済みバックアップの最大数を指定します。指定した場合、このバックアップ プランのスケジュール設定されたバックアップのうち、一度にアクティブな状態にできるのはこの数までです。指定しない場合、デフォルトは 2 です。

状態

基になる型: string バックアップ プランの現在の状態を指定する値。

表示場所: - BackupPlanStatus

SubstitutionRule

置換のルールを定義します。

表示場所: - RestoreConfig

フィールド 説明
target SubstitutionTarget リソースが置換候補であり、指定された JSONPath 値と一致するフィールドがあるかどうかを確認する一致条件。
originValuePattern 文字列 指定された Target 値から照合された JSON 値に適用される正規表現パターン文字列。指定しない場合、指定された NewValue 値を使用して元の値が常に置き換えられます。空の文字列は有効な正規表現パターンであり、他の文字列と同様に扱われます。
newValue 文字列 置き換える値を文字列形式で指定します。

SubstitutionTarget

置換のターゲット候補のルールを定義します。

表示場所: - SubstitutionRule

フィールド 説明
namespaces 文字列配列 置換ルールが適用されるターゲット Namespace のリスト。リソースの元の Namespace は、置換候補と見なされるために、リスト内の名前のいずれかと一致する必要があります。名前空間のないリソースを考慮するには、空の文字列を指定する必要があります。空の場合、すべての名前空間が考慮されます。
groupKinds GroupKind の配列 置換ルールが適用されるターゲット GroupKind リソースのリスト。リソースの元の GroupKind リソースは、置換候補と見なされるために、リストで指定された GroupKind リソースのいずれかと一致する必要があります。空の場合、すべての GroupKind リソースが考慮されます。リソースが置換候補と見なされるには、名前空間の要件と GroupKind の要件の両方を満たす必要があります。
jsonPath 文字列 置換用の JSON 形式のターゲット リソース内のフィールドにつながる JSON パスの文字列表現。

TargetCluster

データのバックアップまたは復元が行われるクラスタを表します。

表示される場所: - ClusterBackupPlanSpec - ClusterBackupSpec - ClusterRestorePlanSpec - ClusterRestoreSpec - ClusterVolumeBackupSpec - ClusterVolumeRestoreSpec

フィールド 説明
targetClusterType TargetClusterType クラスタのタイプ
targetClusterName TypedLocalObjectReference UserCluster の場合、この名前は clusters.cluster.gdc.goog グループの種類の下にある同じ Namespace 内の GDC クラスタを指します。Management API の場合、このフィールドは空のままにする必要があります。

TargetClusterType

基になる型: string

表示場所: - TargetCluster

TransformationRule

jsonPatch を利用した変換ルールを定義します。

表示場所: - RestoreConfig

フィールド 説明
fieldActions TransformationRuleAction 配列 JSON Patch RFC に基づいて候補リソースに対して実行するオペレーションのリスト。
resourceFilter ResourceFilter リソースが変換候補かどうかを判断するために確認する一致条件。空または空白の resourceFilter 値を指定すると、すべてのリソースが一致します。

TransformationRuleAction

リソースの変換の一部としてユーザーが実行するアクションを表します。

表示場所: - TransformationRule

フィールド 説明
op TransformationRuleOperation 復元オペレーションでリソースを変換する際にユーザーが実行するアクションのタイプ。有効なオペレーションのリストは、https://www.rfc-editor.org/rfc/rfc6902#section-4.4 で確認できます。
from 文字列 移動オペレーションとコピー オペレーションのターゲット リソース内のフィールドにつながる JSON 内のパスの JSON パッチ表現。
path 文字列 一部のオペレーションでターゲット リソースのフィールドにつながる JSON 内のパスの JSON パッチ表現。
value 文字列 変換に使用する値を文字列形式で指定します。

TransformationRuleOperation

基になる型: string 変換ルールの目的のオペレーション。

表示場所: - TransformationRuleAction

VMBackupJobList

バックアップのリストが含まれます。

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 VMBackupJobList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items VMBackupJob 配列

VMBackupJobSpec

バックアップの望ましい状態を定義します。

表示場所: - VMBackupJob

フィールド 説明
backupRef NamespacedName VM バックアップ ジョブに関連付けられているコントロール プレーン バックアップ名。名前は変更できません。
vmRef NamespacedName この CR がバックアップしている VM の参照。バックアップがディスク バックアップの場合、この参照は nil になる可能性があります。
vmDiskRefs VMDisk の配列 この CR がバックアップしている VM ディスクのリスト
volumeBackupRefs オブジェクト（キー:文字列、値:VolumeBackup） このバックアップのボリューム バックアップ名と VolumeBackup 構造体のマッピング。このデータは VMBackupJob に埋め込まれており、クラスタには存在しません。
description 文字列 バックアップの説明（省略可）。このフィールドは機能に影響しません。
manual ブール値 バックアップ リソースが手動で作成されたかどうかを指定します。True の場合、このバックアップは手動で作成されています。False の場合、このバックアップはバックアップ プランのスケジュールから自動的に作成されています。
deleteLockDays 整数 このバックアップの create_time から削除がブロックされる日数。バックアップ スケジュールから自動的に作成されたバックアップの場合、このフィールドは BackupPlan.RetentionPolicy.backup_delete_block_days の値に設定されます。このフィールドを指定せずに手動で作成されたバックアップの場合、サービスは BackupPlan.RetentionPolicy.backup_delete_block_days の値を割り当てます。このフィールドの値が BackupPlan.RetentionPolicy.backup_delete_block_days の値よりも小さいバックアップが作成されると、サービスから無効な回答が返されます。このフィールドは、0-90 の整数値でなければなりません。このフィールドは更新リクエストによってのみ増やす必要があります。そうでない場合、サービスから無効な回答が返されます。このフィールドは、Succeeded 状態のバックアップにのみ適用されます。デフォルトは 0 です。
retainDays 整数 このバックアップを保持する日数。この日数を過ぎると、バックアップは自動的に削除されます。これはバックアップの create_time から計算されます。このフィールドが指定されていない場合、または 0 に設定されている場合、バックアップは自動的に削除されません。バックアップ スケジュールから自動的に作成されたバックアップの場合、このフィールドには BackupPlan.RetentionPolicy.backup_retain_days の値が割り当てられます。このフィールドを指定せずに手動で作成されたバックアップの場合、サービスは BackupPlan.RetentionPolicy.backup_retain_days の値を割り当てます。このフィールドの値が delete_lock_days の値よりも小さいバックアップが作成された場合、サービスは無効な回答を返します。このフィールドは更新リクエストによってのみ増やす必要があります。そうでない場合、サービスから無効な回答が返されます。デフォルトは 0 です。

VMBackupJobStatus

バックアップの観測された状態を定義します。

表示場所: - VMBackupJob

フィールド 説明
state VMBackupJobState バックアップの現在の状態。
reason 文字列 バックアップが現在の状態である理由に関する説明（人が読める形式）。
errorStatus ErrorStatus 直近のエラーと観測時刻が含まれます。
conditions 条件の配列 conditions は、この VMBackupJob の現在の状態の観測値を表します。既知の条件タイプ: 成功
createTime 時間 この VMBackupJob リソースが作成されたときのタイムスタンプ。これは RFC 3339 との間で変換できます。
snapshotTime 時間 VMBackupJob リソース内のすべてのディスクのスナップショットが作成されたときのタイムスタンプ。これは RFC 3339 との間で変換できます。
updateTime 時間 この VMBackupJob が最後に更新されたときのタイムスタンプ。これは RFC 3339 との間で変換できます。
volumeCount 整数 バックアップされたボリュームの合計数。
retryCount 整数 この VM/VM ディスクのバックアップに必要な再試行の合計数
deleteLockExpireTime 時間 削除ロックの有効期限が切れる時刻。これは、create_time と delete_lock_days の結合値から計算される出力専用フィールドです。バックアップの delete_lock_days フィールドが更新されると、それに応じてこのフィールドも更新されます。このフィールドは、Succeeded 状態のバックアップにのみ適用されます。
retainExpireTime 時間 バックアップが自動的に削除される時刻。これは、create_time と retain_days の結合値から計算される出力専用フィールドです。バックアップの retain_days フィールドが更新されると、それに応じてこのフィールドも更新されます。
completeTime 時間 バックアップの完了時間。

VMDisk

表示場所: - VMBackupJobSpec

フィールド 説明
namespace 文字列 VM ディスクが存在する Namespace
name 文字列 VM ディスクの名前
pvcName 文字列 基盤となる PVC の名前
uid UID このフィールドは、PVC の UID を指定して、この特定の VMBackupJob を取得するために使用されます。
sizeBytes 整数 合計サイズ（バイト単位）。

VolumeBackup

VolumeBackup API のスキーマを定義します。

表示される場所: - VMBackupJobSpec - VolumeBackupList

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 VolumeBackup
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec VolumeBackupSpec
status VolumeBackupStatus

VolumeBackupFormat

基になる型: string ボリューム バックアップの形式を指定する列挙型。

表示される場所: - VolumeBackupStatus

VolumeBackupList

VolumeBackup リソースのリストが含まれます。

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 VolumeBackupList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items VolumeBackup の配列

VolumeBackupSpec

ボリューム バックアップの望ましい状態を定義します。

表示場所: - VolumeBackup

フィールド 説明
clusterName 文字列 このボリューム バックアップがデータを保持するクラスタの名前。デフォルトでは、このボリューム バックアップが作成されるクラスタです。
backupName 文字列 関連付けられているバックアップの名前。各ボリューム バックアップはバックアップに関連付ける必要があります。
backupPlanName 文字列 関連付けられたバックアップが作成されたバックアップ プランの名前。
sourcePVC NamespacedName ボリューム バックアップの取得元となるソース Persistent Volume Claim。
volumeBackupHandle 文字列 ボリューム バックアップ リポジトリ内のボリューム バックアップを一意に識別する基盤となるボリューム バックアップ ハンドル。このハンドルには統一された形式がなく、不透明な文字列として扱われます。非推奨: 代わりにステータス フィールドを使用してください。

VolumeBackupState

基になる型: string ボリューム バックアップの現在の状態を示す列挙型。

表示される場所: - VolumeBackupStatus

VolumeBackupStatus

ボリューム バックアップの観測状態を定義します。

表示場所: - VolumeBackup

フィールド 説明
volumeBackupHandle 文字列 基盤となるボリューム バックアップ ハンドル。ボリューム バックアップ リポジトリ内のボリューム バックアップを一意に識別します。このハンドルには統一された形式がなく、不透明な文字列として扱われます。
format VolumeBackupFormat ボリュームのバックアップ形式。（PD、Portable など）。
storageBytes 整数 バックアップ ストレージ内のボリューム バックアップのサイズ。増分バックアップの場合、以前のボリューム バックアップのいずれかが削除されると、この値は動的に変更されることがあります。
diskSizeBytes 整数 このボリューム バックアップを復元できるディスクの最小サイズ。
state VolumeBackupState ボリューム バックアップの現在の状態。
message 文字列 バックアップがこの状態にある理由の詳細を示す、人間が読めるメッセージ。
completeTime 時間 この VolumeBackup リソースが完了したときのタイムスタンプ（RFC 3339 のテキスト形式）。
errorStatus ErrorStatus 直近のエラーと観測時刻が含まれます。
conditions 条件の配列 conditions は、この VolumeBackup の現在の状態の観測値を表します。

VolumeDataRestorePolicy

基盤となるタイプ: string さまざまなボリューム データ復元ポリシー。

表示場所: - RestoreConfig - RestorePolicies

VolumeRestore

VolumeRestore API のスキーマを定義します。

表示場所: - VolumeRestoreList

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 VolumeRestore
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec VolumeRestoreSpec
status VolumeRestoreStatus

VolumeRestoreList

VolumeRestore リソースのリストが含まれます。

フィールド 説明
apiVersion 文字列 backup.gdc.goog/v1
kind 文字列 VolumeRestoreList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items VolumeRestore の配列

VolumeRestoreSpec

ボリューム復元の望ましい状態を定義します。

表示場所: - VolumeRestore

フィールド 説明
clusterName 文字列 このボリューム復元からのデータを含むクラスタの名前。デフォルトでは、このボリューム復元が作成されるクラスタです。
restoreName 文字列 このボリューム復元を作成した復元リソースの名前。
volumeBackupName 文字列 復元するボリューム バックアップ リソースの名前。
targetPvc NamespacedName 復元するターゲット PersistentVolumeClaim リソース。

VolumeRestoreStatus

ボリューム復元の観測された状態を定義します。

表示場所: - VolumeRestore

フィールド 説明
volumeBackupHandle 文字列 基盤となるボリューム バックアップ ハンドル。ボリューム バックアップ リポジトリ内のボリューム バックアップを一意に識別します。このハンドルには統一された形式がなく、不透明な文字列として扱われます。
state VolumeRestoreState ボリューム復元の現在の状態。
stateMessage 文字列 現在の状態の説明（人が読める形式）。
conditions 条件の配列 conditions は、この Volume Restore の現在の状態の観測値を表します。既知の条件タイプ: Ready。
completeTime 時間 ボリュームの復元プロセスの終了時刻。

VolumeStrategy

基になるタイプ: string ボリュームのバックアップ時に使用するトレードオフ。

表示場所: - BackupConfig