REST Resource: projects.locations.backupPlans.backups

• リソース: バックアップ
  • JSON 表現
• ClusterMetadata
  • JSON 表現
• 状態
• メソッド

リソース: バックアップ

GKE クラスタの状態の一部、バックアップ オペレーション自体の記録、バックアップを構成する基盤となるアーティファクト（構成ファイルのバックアップと VolumeBackups）のアンカーの 1 つの時点のキャプチャを実行するリクエストを表します。次の ID: 28

JSON 表現

{ "name": string, "uid": string, "createTime": string, "updateTime": string, "manual": boolean, "labels": { string: string, ... }, "deleteLockDays": integer, "deleteLockExpireTime": string, "retainDays": integer, "retainExpireTime": string, "encryptionKey": { object (EncryptionKey) }, "containsVolumeData": boolean, "containsSecrets": boolean, "clusterMetadata": { object (ClusterMetadata) }, "state": enum (State), "stateReason": string, "completeTime": string, "resourceCount": integer, "volumeCount": integer, "sizeBytes": string, "etag": string, "description": string, "podCount": integer, "configBackupSizeBytes": string, // Union field backup_scope can be only one of the following: "allNamespaces": boolean, "selectedNamespaces": { object (Namespaces) }, "selectedApplications": { object (NamespacedNames) } // End of list of possible types for union field backup_scope. }

フィールド
name	string 出力専用。バックアップの完全修飾名。projects/*/locations/*/backupPlans/*/backups/*
uid	string 出力専用。サーバー生成のグローバル固有識別子（UUID4）
createTime	string (Timestamp format) 出力専用。このバックアップ リソースが作成されたときのタイムスタンプ。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
updateTime	string (Timestamp format) 出力専用。このバックアップ リソースが最後に更新されたときのタイムスタンプ。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
manual	boolean 出力専用。このフラグは、このバックアップ リソースがユーザーによって手動で作成されたか、BackupPlan のスケジュールによって作成されたかを示します。値が True の場合、バックアップは手動で作成されています。
labels	map (key: string, value: string) ユーザーが指定した一連のカスタムラベル。 "key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }。
deleteLockDays	integer このバックアップの最小存続期間（日数）。このフィールドにゼロ以外の値を設定すると、指定した日数（バックアップの作成時から測定）の間、バックアップは削除（手動または自動）されないように「ロック」されます。0～90 の整数値でなければなりません。 デフォルトでは、親 BackupPlan の backupDeleteLockDays 設定が使用され、増やす（作成時またはその後の更新時）ことができます。
deleteLockExpireTime	string (Timestamp format) 出力専用。このバックアップの既存の削除ロックの有効期限が切れる時刻（createTime + deleteLockDays から計算）。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
retainDays	integer このバックアップが自動的に削除されるまでの期間（日数）。0 以上の整数値にする必要があります。 0 の場合、このバックアップは自動的に削除されません。 0 以外の場合は、deleteLockDays 以上 365 以下にする必要があります。 バックアップの作成後、この値を増やすことは可能ですが、減らすことはできません。 デフォルトは、親 BackupPlan の backupRetainDays 値です。
retainExpireTime	string (Timestamp format) 出力専用。このバックアップが自動的に削除される時刻（createTime + retainDays から計算）。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
encryptionKey	object (EncryptionKey) 出力専用。バックアップのアーティファクトの暗号化に使用された顧客管理の暗号鍵。親 BackupPlan の encryptionKey 値から継承されます。
containsVolumeData	boolean 出力専用。バックアップにボリューム データが含まれているかどうか。親 BackupPlan の includeVolumeData 値によって制御されます。
containsSecrets	boolean 出力専用。バックアップに Kubernetes Secret が含まれているかどうか。親 BackupPlan の includeSecrets 値によって制御されます。
clusterMetadata	object (ClusterMetadata) 出力専用。このバックアップが作成された GKE クラスタに関する情報。
state	enum (State) 出力専用。バックアップの現在の状態
stateReason	string 出力専用。バックアップが現在の state にある理由に関する説明（人が読める形式）。
completeTime	string (Timestamp format) 出力専用。バックアップの完了時間 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
resourceCount	integer 出力専用。バックアップに含まれる Kubernetes リソースの合計数。
volumeCount	integer 出力専用。バックアップに含まれるボリューム バックアップの合計数。
sizeBytes	string (int64 format) 出力専用。バックアップの合計サイズ（バイト）= 構成のバックアップ サイズ + 合計（ボリューム バックアップ サイズ）
etag	string 出力専用。etag は、オプティミスティック同時実行制御でバックアップの同時更新による相互上書きを防ぐために使用されます。競合状態の発生を回避する目的で、システムのバックアップ更新の読み込み・変更・書き込みサイクルでは etag を活用することを強くおすすめします。backups.get へのレスポンスでは etag が返されます。その etag を backups.patch または backups.delete に対するリクエストに配置すれば、対応する変更が同じバージョンのリソースに確実に適用されるようになります。
description	string ユーザーが指定した、このバックアップの説明文字列。
podCount	integer 出力専用。バックアップに含まれる Kubernetes Pod の合計数。
configBackupSizeBytes	string (int64 format) 出力専用。構成のバックアップのサイズ（バイト単位）。
共用体フィールド backup_scope。バックアップの「スコープ」を定義します。これは、クラスタ内のどの名前空間リソースがバックアップに含まれているかを定義します。親 BackupPlan の [backup_scope][google.cloud.gkebackup.v1.BackupPlan.BackupConfig.backup_scope] 値から継承されます。backup_scope は次のいずれかになります。
allNamespaces	boolean 出力専用。True の場合、すべての名前空間がバックアップに含まれています。
selectedNamespaces	object (Namespaces) 出力専用。設定されている場合、バックアップに含まれる名前空間のリスト。
selectedApplications	object (NamespacedNames) 出力専用。設定されている場合、リソースがバックアップに含まれている ProtectedApplication のリスト。

ClusterMetadata

このバックアップが作成された GKE クラスタに関する情報。

JSON 表現
{ "cluster": string, "k8sVersion": string, "backupCrdVersions": { string: string, ... }, // Union field platform_version can be only one of the following: "gkeVersion": string, "anthosVersion": string // End of list of possible types for union field platform_version. }

フィールド
cluster	string このバックアップが作成されたソースクラスタ。有効な形式: projects/*/locations/*/clusters/* projects/*/zones/*/clusters/* これは、親 BackupPlan の cluster フィールドから継承されます。
k8sVersion	string 移行元クラスタの Kubernetes サーバー バージョン。
backupCrdVersions	map (key: string, value: string) クラスタで検出された Backup for GKE CRD バージョンのリスト。 "key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }。
共用体フィールド platform_version。プラットフォーム固有のバージョン platform_version は、次のいずれか 1 つだけにすることができます。
gkeVersion	string GKE バージョン
anthosVersion	string Anthos のバージョン

状態

状態

列挙型
STATE_UNSPECIFIED	バックアップ リソースは作成中です。
CREATING	バックアップ リソースが作成され、関連する BackupJob Kubernetes リソースがソースクラスタに挿入されました。
IN_PROGRESS	クラスタ内の gkebackup エージェントがバックアップ オペレーションの実行を開始しました。
SUCCEEDED	バックアップ オペレーションが正常に完了しました。
FAILED	バックアップ オペレーションが失敗しました。
DELETING	このバックアップ リソース（および関連するアーティファクト）は削除中です。

方法
create	指定された BackupPlan のバックアップを作成します。
delete	既存のバックアップを削除します。
get	1 つのバックアップの詳細を取得します。
getIamPolicy	リソースのアクセス制御ポリシーを取得します。
list	指定された BackupPlan のバックアップを一覧表示します。
patch	バックアップを更新します。
setIamPolicy	指定したリソースにアクセス制御ポリシーを設定します。
testIamPermissions	呼び出し元が指定されたリソース上で持つ権限を返します。