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、所選命名空間和所選應用程式。您必須為 backup_scope 指定單一值。BackupScope 值必須是下列其中一種型別:BackupConfig_AllNamespaces、BackupConfig_SelectedNamespaces 或 BackupConfig_SelectedApplications。 |
backupRepository 字串 |
BackupRepository 資源的名稱,用於識別這個 BackupPlan 資源的次要儲存空間。 |
includeVolumeData boolean |
指出是否備份磁碟區資料。如未設定,預設值為 False。 |
includeSecrets boolean |
指出是否備份密鑰。如未設定,預設值為 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 boolean |
指出方案是否已停用。將這個欄位設為「True」會鎖定方案,也就是不允許進一步更新,包括變更停用欄位。此外,系統也不會再依據這項方案建立新的備份 (無論是手動或排定時間)。預設值為「False」。 |
BackupPlanStatus
定義備份方案的觀察狀態。
顯示位置: - BackupPlan
| 欄位 | 說明 |
|---|---|
lastBackupTime 時間 |
最近一次執行備份作業的時間戳記。 |
nextBackupTime 時間 |
下次排定備份作業的時間戳記。 |
state 州/省 |
備份方案的目前狀態。 |
lastBackupState BackupState |
最近一次建立的備份狀態。 |
lastBackupStateReason 字串 |
使用者可理解的說明,指出上次備份為何處於目前狀態。 |
errorStatus ErrorStatus |
最近發生的錯誤,包括觀察到的時間。 |
conditions Condition 陣列 |
「條件」代表這項備份方案目前狀態的觀察結果。 |
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,建立的 BackupRepository 就會是「ReadWrite」。如果叢集是在 ReadOnlyClusters 清單中建立,則為「ReadOnly」。這個欄位無法變更。 |
readWriteCluster NamespacedName |
ReadWriteCluster 會指定單一叢集 (baremetal.cluster.gke.io/Cluster),該叢集有權使用 BackupRepositorySpec 欄位中的資料建立 ReadWrite 備份存放區。ReadWrite 存放區可用於排定/建立備份、備份方案和還原作業,且實際上由建立存放區的叢集擁有。注意:最多只能有一個 k8s 叢集將 BackupRepository 設為 ReadWrite。這個欄位可變更。 |
readOnlyClusters NamespacedName 陣列 |
ReadOnlyClusters 會指定叢集清單 (baremetal.cluster.gke.io/Cluster),這些叢集有權使用 BackupRepositorySpec 欄位中的資料,建立 ReadOnly 備份存放區。ReadOnly 存放區只能用於匯入及查看備份。您無法在這個存放區中建立新的備份/資源,但還原作業可以參考唯讀備份。用於從其他叢集匯入備份,以進行跨叢集還原。BackupRepository 可做為 ReadOnly 使用的次數沒有限制。這個欄位可變更。 |
BackupRepositoryManagerStatus
BackupRepositoryManagerStatus 會定義 BackupRepositoryManager 的觀察狀態
顯示位置: - BackupRepositoryManager
| 欄位 | 說明 |
|---|---|
backupCount 整數 |
BackupCount 是指 BackupRepositorySpec 指向的儲存空間 bucket 內建立的備份總數。 |
backupPlanCount 整數 |
BackupPlanCount 是指 BackupRepositorySpec 指向的儲存空間 bucket 內建立的備份方案總數。 |
restoreCount 整數 |
RestoreCount 是指 BackupRepositorySpec 指向的儲存空間值區內建立的還原總數。 |
restorePlanCount 整數 |
RestorePlanCount 是指 BackupRepositorySpec 指向的儲存空間值區內建立的還原方案總數。 |
clusterStatuses ClusterStatus 陣列 |
ClusterStatuses 包含在每個叢集中建立所需備份儲存空間的目前狀態。清單會包含 ReadOnlyClusters 清單中指定的所有叢集項目,以及 ReadWriteCluster。如果叢集中的備份儲存空間成功建立,ClusterStatuses 陣列中的項目會將「Ready」條件設為「True」,否則會設為「False」。 |
conditions Condition |
條件會指出備份存放區管理工具及其建立的備份存放區是否處於正常狀態。 |
errorStatus ErrorStatus |
包括與觀察時間對帳時發生的最新錯誤。 |
BackupRepositorySpec
定義備份存放區的所需狀態。
顯示位置: - BackupRepository
| 欄位 | 說明 |
|---|---|
secretReference SecretReference |
存取密鑰的參照,取決於您選擇的儲存系統。這個密鑰用於向這個端點發出的要求。例如 S3 存取密鑰。 |
endpoint 字串 |
用於存取備份存放區的端點。如果是 Google Private Cloud,這是提供租戶專案存取權的 S3 端點。 |
type RepositoryType |
備份存放區的類型。例如 S3 或 Google Cloud Storage。這會告知代理程式要使用哪個儲存系統或 API。 |
s3Options S3Options |
用於設定 S3 相容BackupRepo資源存取權的資料。 |
importPolicy ImportPolicy |
這項政策會決定備份存放區是唯讀還是讀寫。 |
importSubstitution ImportSubstitution |
這個欄位會決定是否要將匯入資源的備份存放區名稱,替換為這個備份存放區名稱。 |
force boolean |
指定讀寫備份儲存庫採取的動作,前提是已由其他備份儲存庫聲明初始化儲存空間值區。如果 True,新的備份儲存庫仍會取代現有的 Sentinel 檔案,並使用自己的 Sentinel 檔案,聲明擁有儲存空間值區。如果 False,建立新備份存放區時會發生錯誤。預設值為 False。只有在覆寫的 Sentinel 檔案不再有備份存放區時,才可使用這項功能,否則備份存放區會進入錯誤狀態,可能導致不良的副作用。 |
BackupRepositoryStatus
定義備份存放區的觀察狀態。
顯示位置: - BackupRepository
| 欄位 | 說明 |
|---|---|
sentinelEtag 字串 |
這個欄位會將備份存放區連結至其擁有的 Sentinel 檔案。 |
reconciliationError ReconciliationError |
備份存放區最近一次嘗試調解時發生的錯誤。 |
reconciliationErrorMessage 字串 |
對帳期間可能發生的錯誤訊息。 |
errorStatus ErrorStatus |
包括與觀察時間對帳時發生的最新錯誤。 |
initialImportDone boolean |
指定這個備份存放區是否已完成初始匯入。 |
conditions Condition 陣列 |
「Conditions」代表對這個備份存放區目前狀態的觀察結果。已知條件類型:就緒。 |
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
定義要備份的命名空間和應用程式。
出現位置: - BackupConfig - RestoreConfig
| 欄位 | 說明 |
|---|---|
allNamespaces boolean |
指出是否備份所有命名空間。如果設為 True,表示必須備份所有命名空間。 |
selectedNamespaces 命名空間 |
要備份的命名空間清單。 |
selectedApplications NamespacedNames |
要備份的應用程式清單。 |
BackupSpec
定義備份的所需狀態。
| 欄位 | 說明 |
|---|---|
clusterName 字串 |
備份的叢集名稱。預設為建立這個備份的叢集。 |
backupPlanName 字串 |
建立這個備份的備份方案名稱。 |
backupConfig BackupConfig |
從指定備份方案產生這項備份時使用的設定。這必須從產生備份的備份方案複製,而非參考。使用者不得設定這個欄位,只能由備份方案排程器和 ManualBackupRequest 資源設定。 |
description 字串 |
備份的選填字串說明。這個欄位不會影響功能。 |
manual boolean |
指定備份資源是否為手動建立。如果 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 boolean |
指出是否已為這項備份作業建立備份工作。 |
state BackupState |
備份作業的目前狀態。 |
reason 字串 |
使用者可理解的說明,指出備份目前處於這種狀態的原因。 |
errorStatus ErrorStatus |
最近發生的錯誤,包括觀察到的時間。 |
conditions Condition 陣列 |
條件代表對這個備份目前狀態的觀察結果。已知條件類型:已成功 |
createTime 時間 |
建立這項備份資源的時間戳記。這項設定可轉換為 RFC 3339,也能從 RFC 3339 轉換而來。 |
updateTime 時間 |
上次更新備份方案的時間戳記。這項設定可轉換為 RFC 3339,也能從 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、所選命名空間和所選應用程式。您必須為 backup_scope 指定單一值。BackupScope 值必須是下列其中一種型別:BackupConfig_AllNamespaces、BackupConfig_SelectedNamespaces 或 BackupConfig_SelectedApplications。 |
backupRepositoryName 字串 |
BackupRepositoryRef 資源的名稱,用於識別這個 ClusterBackupPlan 資源的次要儲存空間。 |
clusterBackupRepositoryName 字串 |
ClusterBackupRepositoryRef 資源的名稱,用於識別這個 ClusterBackupPlan 資源的次要儲存空間。 |
includeVolumeData boolean |
指出是否備份磁碟區資料。如未設定,預設值為 false。 |
includeSecrets boolean |
指出是否備份密鑰。如未設定,預設值為 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 boolean |
指出方案是否已停用。將這個欄位設為「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 |
存取密鑰的參照,取決於您選擇的儲存系統。這個密鑰用於向這個端點發出的要求。例如 S3 存取密鑰。 |
endpoint 字串 |
用於存取叢集備份存放區的端點。 |
type RepositoryType |
叢集備份存放區的類型。例如 S3 或 Google Cloud Storage。這會告知代理程式要使用哪個儲存系統或 API。 |
s3Options S3Options |
用於設定 S3 相容BackupRepo資源存取權的資料。 |
importPolicy ImportPolicy |
這項政策會決定備份存放區是唯讀還是讀寫。 |
force boolean |
指定讀寫備份儲存庫採取的動作,前提是已由其他備份儲存庫聲明初始化儲存空間值區。如果 True,新的備份儲存庫仍會取代現有的 Sentinel 檔案,並使用自己的 Sentinel 檔案,聲明擁有儲存空間值區。如果 False,建立新備份存放區時會發生錯誤。預設值為 False。只有在覆寫的 Sentinel 檔案不再有備份存放區時,才可使用這項功能,否則備份存放區會進入錯誤狀態,可能導致不良的副作用。 |
ClusterBackupRepositoryStatus
定義 ClusterBackupRepository 資源的觀察狀態。
顯示於: - ClusterBackupRepository
| 欄位 | 說明 |
|---|---|
sentinelEtag 字串 |
這個欄位會將備份存放區連結至其擁有的 Sentinel 檔案。 |
reconciliationError ReconciliationError |
備份存放區最近一次嘗試調解時發生的錯誤。 |
reconciliationErrorMessage 字串 |
對帳期間可能發生的錯誤訊息。 |
errorStatus ErrorStatus |
包括與觀察時間對帳時發生的最新錯誤。 |
conditions Condition 陣列 |
指定叢集備份存放區的狀態。支援的條件包括 InitialImportDone、Ready、Deprecated。 |
ClusterBackupSpec
代表包裝 backupv1.Backup 自訂資源的 API。 兩者大致相同,但部分欄位會選擇性省略。
顯示位置: - ClusterBackup
| 欄位 | 說明 |
|---|---|
targetCluster TargetCluster |
要備份的叢集名稱。 |
clusterBackupPlanName 字串 |
建立這個備份的叢集備份方案名稱。 |
backupConfig ClusterBackupConfig |
從指定備份方案產生這項備份時使用的設定。這項資訊必須從產生叢集備份的叢集備份方案複製,而非參考。使用者不得設定這個欄位,只能由備份方案排程器和 ManualBackupRequest 資源設定。 |
description 字串 |
備份的選用字串說明。這個欄位不會影響功能。 |
manual boolean |
指出叢集備份資源是否為手動建立。如果顯示 True,表示備份是手動建立;如果顯示 False,表示叢集備份是根據備份方案排程自動建立。 |
retentionPolicy BackupRetentionPolicy |
備份資料的保留政策。 |
ClusterBackupStatus
定義叢集備份的觀察狀態。
顯示位置: - ClusterBackup
| 欄位 | 說明 |
|---|---|
clusterMetadata ClusterMetadata |
叢集的中繼資料。 |
conditions Condition 陣列 |
指定叢集備份的狀態。支援的條件包括 JobCreated、Succeeded。 |
jobCreated boolean |
指出是否已為這個叢集備份建立備份工作。 |
state BackupState |
叢集備份的目前狀態。 |
stateReason 字串 |
使用者可理解的說明,指出備份目前處於這種狀態的原因。 |
errorStatus ErrorStatus |
最近發生的錯誤,包括觀察到的時間。 |
createTime 時間 |
建立這項備份資源的時間戳記。這項設定可轉換為 RFC 3339,也能從 RFC 3339 轉換而來。 |
updateTime 時間 |
上次更新這個叢集備份的時間戳記。這項設定可轉換為 RFC 3339,也能從 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
發生衝突時,非命名空間叢集資源應遵循的還原行為。
顯示於: - RestoreConfig - RestorePolicies
ClusterResourceSelection
代表要還原的非命名空間資源選取項目。
出現位置: - RestoreConfig - RestoreResourceSelection
| 欄位 | 說明 |
|---|---|
selectedGroupKinds GroupKind 陣列 |
GroupKind 資源清單。清單中指定的 GroupKind 資源必須包含非命名空間資源。請注意,即使 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 |
要用於命名空間資源的還原模式。如果這個欄位的值為 NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED,且指定了 namespaced_resource_restore_scope,要求即為無效。 |
clusterResources ClusterResourceSelection |
要還原的非命名空間資源。如未指定這個欄位,系統就不會還原任何叢集資源。請注意,即使 PersistentVolume 資源沒有命名空間,系統也會分開處理。詳情請參閱 VolumeDataRestorePolicy 資源。指定這份清單中的 PersistentVolume GroupKind,不會決定是否還原 PersistentVolume。 |
namespacedResourceAllowlist GroupKind 陣列 |
要還原的特定命名空間資源。如果已定義,系統只會還原這個 allowlist 中定義的資源。 |
namespacedResourceRestoreScope BackupScope |
要還原的所選命名空間資源。必須指定其中一個項目,以及有效的 Type。可指派給 restoreScope 的有效 Type 值為 AllNamespaces、SelectedNamespaces 或 SelectedApplications。 |
substitutionRules SubstitutionRule 陣列 |
取代備份 Kubernetes 資源時遵循的規則。如果清單為空白,表示不會進行任何替換。系統會依定義的順序,依序套用替代規則。這個順序非常重要,因為規則所做的變更可能會影響後續規則的相符邏輯。針對特定還原作業,只能指定 SubstitutionRules 或 TransformationRules 其中之一。 |
transformationRules TransformationRule 陣列 |
轉換備份 Kubernetes 資源時遵循的規則。如果清單為空白,表示不會進行任何轉換。系統會依定義的順序依序套用轉換規則。這個順序很重要,因為規則所做的變更可能會影響後續規則的相符邏輯。針對特定還原作業,只能指定 SubstitutionRules 或 TransformationRules 其中之一。 |
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 字串 |
叢集備份的名稱,必須與叢集還原位於相同命名空間。 |
clusterRestorePlanName 字串 |
這個叢集還原方案的名稱,叢集還原作業是從這個方案繼承 ClusterRestoreConfig 資源。 |
clusterRestoreConfig ClusterRestoreConfig |
叢集還原的設定。 |
description 字串 |
叢集還原作業的選填說明。這不會影響功能。 |
filter 篩選器 |
除了 ClusterRestorePlan 中定義的粗略範圍外,您還可以使用篩選器進一步修正叢集還原的資源選取範圍。 |
ClusterRestoreStatus
定義叢集還原作業的觀察狀態。
顯示於: - ClusterRestore
| 欄位 | 說明 |
|---|---|
conditions Condition 陣列 |
指定叢集還原作業的狀態。支援的條件包括 JobCreated、Succeeded。 |
state RestoreState |
叢集還原作業的目前狀態。 |
stateReason 字串 |
使用者可理解的說明,指出叢集還原作業為何處於目前狀態。 |
errorStatus ErrorStatus |
最近發生的錯誤,包括觀察到的時間。 |
resourcesRestoredCount 整數 |
這項叢集還原動作還原的資源數量。 |
resourcesExcludedCount 整數 |
這項叢集還原作業排除的資源數量。 |
resourcesFailedCount 整數 |
這項叢集還原作業中,無法還原的資源數量。 |
restoredVolumesCount 整數 |
這項叢集還原動作還原的磁碟區數量。 |
startTime 時間 |
叢集還原程序的建立時間。 |
completeTime 時間 |
叢集還原程序的結束時間。 |
ClusterStatus
ClusterStatus 包含特定叢集的備份存放區建立狀態。
出現位置: - BackupRepositoryManagerStatus
| 欄位 | 說明 |
|---|---|
cluster NamespacedName |
|
conditions Condition 陣列 |
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 字串 |
相關聯備份的名稱。每個叢集磁碟區備份都必須與備份建立關聯。一律位於同一個命名空間。 |
clusterBackupPlanName 字串 |
建立相關聯備份的備份方案名稱。一律位於同一個命名空間。 |
sourcePVC TypedObjectReference |
叢集磁碟區備份的來源永久磁碟區要求。 |
ClusterVolumeBackupStatus
定義叢集磁碟區備份的觀察狀態。
顯示位置: - ClusterVolumeBackup
| 欄位 | 說明 |
|---|---|
volumeBackupHandle 字串 |
基礎叢集磁碟區備份控制代碼,可唯一識別備份存放區內的叢集磁碟區備份。這個控制代碼沒有統一格式,會被視為不透明字串。 |
format VolumeBackupFormat |
叢集磁碟區備份格式。例如 PD、Portable 等。 |
storageBytes 整數 |
備份儲存空間中叢集磁碟區備份的大小。如果刪除先前的磁碟區備份,這個值可能會動態變更。 |
diskSizeBytes 整數 |
可還原這個磁碟區備份的磁碟最小大小。 |
state VolumeBackupState |
磁碟區備份的目前狀態。 |
message 字串 |
使用者可理解的訊息,說明備份處於此狀態的原因。 |
completeTime 時間 |
這個 ClusterVolumeBackup 資源完成的時間戳記,採用 RFC 3339 的文字格式。 |
conditions Condition 陣列 |
指定叢集磁碟區備份的狀態。 |
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 資源位於相同命名空間。 |
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 資源位於相同命名空間。 |
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 陣列 |
排除要還原的資源。如果指定排除篩選器,系統就不會還原符合任何 ResourceSelector 的資源。 |
ImportPolicy
基礎類型: string
這項政策會決定備份存放區是唯讀還是讀寫。
顯示位置: - BackupRepositorySpec
ImportSubstitution
表示是否要替換匯入資源的備份存放區名稱。
顯示位置: - BackupRepositorySpec
| 欄位 | 說明 |
|---|---|
substituteBRName boolean |
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 資源相同的命名空間中。 |
clusterBackupPlanRef 字串 |
從中提取 ClusterBackupConfig 資源的叢集備份方案名稱。請注意,叢集備份方案應與 ManualClusterBackupRequest 資源位於相同命名空間。 |
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 資源位於相同命名空間。 |
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 中定義的粗略範圍。 |
ManualRestoreRequestStatus
定義 ManualRestoreRequest 資源的觀察狀態。
顯示於: - ManualRestoreRequest
| 欄位 | 說明 |
|---|---|
timeToExpire 時間 |
資源應過期的時間。 |
statusField StatusFields |
ManualRestoreRequest 資源的觀察狀態。 |
NamespacedName
在特定命名空間中定義名稱。
顯示於: - NamespacedNames - NamespacedResourceSelection - VolumeBackupSpec - VolumeRestoreSpec
| 欄位 | 說明 |
|---|---|
namespace 字串 |
Kubernetes 中資源的命名空間。 |
name 字串 |
Kubernetes 中的資源名稱。 |
NamespacedNames
顯示位置: - BackupScope
| 欄位 | 說明 |
|---|---|
namespacedNames NamespacedName 陣列 |
命名空間名稱清單。 |
NamespacedResourceRestoreMode
基礎型別: string
命名空間資源的還原行為。
顯示於: - RestoreConfig - RestorePolicies
NamespacedResourceSelection
定義要還原的命名空間資源選取項目。
必須指定下列其中一個值,並搭配相符的 Type:
`AllNamespaces`, `SelectedNamespaces`, or `SelectedApplications`.
顯示位置: - RestoreResourceSelection
| 欄位 | 說明 |
|---|---|
type NamespacedResourceSelectionType |
要使用的選取類型。 |
allNamespaces boolean |
指出是否要還原備份中的所有命名空間資源。如果未指定這個欄位,或將這個欄位設為 False,且 Type 設為 NamespacedResourceSelectionType.AllNamespaces,則無效。 |
selectedNamespaces 字串陣列 |
要還原的所選命名空間清單。如果提供值,且 Type 設為 NamespacedResourceSelectionType.SelectedNamespaces,系統會還原指定清單中具有原始命名空間的資源。請注意,在此清單中指定空字串不會還原非命名空間叢集資源。如要還原叢集資源,請參閱 ClusterResourceSelection。 |
selectedApplications NamespacedName 陣列 |
要還原的所選ProtectedApplication資源清單。如果提供值,且 Type 設為 NamespacedResourceSelectionType.SelectedApplications,系統會還原其中一個列出應用程式的資源。 |
NamespacedResourceSelectionType
基礎類型: string
命名空間資源選取類型。
出現位置: - NamespacedResourceSelection
命名空間
顯示位置: - BackupScope
| 欄位 | 說明 |
|---|---|
namespaces 字串陣列 |
命名空間清單。 |
ObjectStorageBackupConfig
設定物件儲存空間的備份。
| 欄位 | 說明 |
|---|---|
apiVersion 字串 |
backup.gdc.goog/v1 |
kind 字串 |
ObjectStorageBackupConfig |
metadata ObjectMeta |
如需 metadata 的欄位,請參閱 Kubernetes API 說明文件。 |
source ObjectStorageEndpoint |
要備份的來源物件儲存空間。 |
target ObjectStorageEndpoint |
備份寫入的目標。 |
timestamp boolean |
指定是否要將每個轉移作業儲存在值區的子路徑中,並加上時間戳記。如果設為 True,結構為 YYYY-MM-DD-hh:mm:ss。這有助於儲存備份在多個時間點建立的副本。預設值為 False。 |
ObjectStorageEndpoint
代表物件儲存端點,以及存取該端點的憑證。
出現位置: - ObjectStorageBackupConfig
| 欄位 | 說明 |
|---|---|
endpoint 字串 |
用來存取物件儲存空間的端點。例如 https://s3.svc。 |
bucket 字串 |
端點內的 bucket,用於設定參照範圍。 |
secretReference SecretReference |
用於存取物件儲存空間的 S3 存取憑證參照。 |
PlatformVersion
定義平台版本。
顯示於: - ClusterMetadata
| 欄位 | 說明 |
|---|---|
gpcVersion 字串 |
Google 私有雲版本。 |
ReconciliationError
基礎類型: string
備份存放區最近一次嘗試調解時發生的錯誤。
顯示位置: - BackupRepositoryStatus
RepositoryType
基礎型別: string
要寫入的端點型別。
顯示位置: - BackupRepositorySpec
ResourceFilter
定義規則,篩選備選資源清單,以提供轉換規則。所有標有 ResourceFilter 的欄位皆為選填,因此如未指定任何 ResourceFilter 欄位,系統會比對所有資源。
出現位置: - TransformationRule
| 欄位 | 說明 |
|---|---|
namespaces 字串陣列 |
轉換規則套用的目標命名空間清單。資源的原始命名空間必須與清單中的其中一個名稱相符,才能視為轉換候選項目。如要納入任何非命名空間資源,清單中必須包含空字串。如果留空,系統會將所有命名空間納入考量。 |
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 字串 |
使用命名空間選取資源。這項功能僅適用於命名空間範圍內的資源,無法用於選取叢集範圍內的資源。如果指定命名空間,系統只會選取該命名空間中的資源。如未指定,篩選器會同時套用至叢集範圍和命名空間範圍的資源 (例如名稱或標籤)。只有在還原命名空間內的任何資源時,系統才會還原命名空間資源本身。 |
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 |
要用於命名空間資源的還原模式。如未指定這個欄位,要求就會無效。如果這個欄位的值為 NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED,且指定了 namespaced_resource_restore_scope,要求即為無效。 |
clusterResources ClusterResourceSelection |
要還原的非命名空間資源。如未指定這個欄位,系統就不會還原任何叢集資源。請注意,即使 PersistentVolume 資源沒有命名空間,系統也會分開處理。詳情請參閱 VolumeDataRestorePolicy 資源。指定這份清單中的 PersistentVolume GroupKind,不會決定是否還原 PersistentVolume。 |
namespacedResourceAllowlist GroupKind 陣列 |
要還原的特定命名空間資源。如果已定義,系統只會還原這個 allowlist 中定義的資源。 |
restoreScope BackupScope |
要還原的所選命名空間資源。必須指定其中一個項目,以及有效的 Type。可指派給 restoreScope 的有效 Type 值為 AllNamespaces、SelectedNamespaces 或 SelectedApplications。 |
substitutionRules SubstitutionRule 陣列 |
取代備份 Kubernetes 資源時遵循的規則。如果清單為空白,表示不會進行任何替換。系統會依定義的順序,依序套用替代規則。這個順序非常重要,因為規則所做的變更可能會影響後續規則的相符邏輯。針對特定還原作業,只能指定 SubstitutionRules 或 TransformationRules 其中之一。 |
transformationRules TransformationRule 陣列 |
轉換備份 Kubernetes 資源時遵循的規則。如果清單為空白,表示不會進行任何轉換。系統會依定義的順序依序套用轉換規則。這個順序很重要,因為規則所做的變更可能會影響後續規則的相符邏輯。針對特定還原作業,只能指定 SubstitutionRules 或 TransformationRules 其中之一。 |
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 中定義的粗略範圍外,篩選器還可用於進一步修正還原的資源選取範圍。 |
RestoreState
基礎類型: string
顯示於: - RestoreStatus
RestoreStatus
定義還原作業的觀察狀態。
| 欄位 | 說明 |
|---|---|
state RestoreState |
還原作業的目前狀態。 |
stateReason 字串 |
使用者可理解的說明,指出還原作業為何處於目前狀態。 |
errorStatus ErrorStatus |
最近發生的錯誤,包括觀察到的時間。 |
conditions Condition 陣列 |
「條件」代表觀察到的這項還原作業目前狀態。已知條件類型:已成功 |
jobCreated boolean |
指出是否已為這項還原作業建立還原工作。 |
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 boolean |
指出這項備份方案的保留政策是否已鎖定。如果設為 True,這項政策就無法再更新,包括 locked 欄位本身。預設值為 False。 |
numBackupsToRetain 整數 |
要保留的備份數量。如果指定了這項值,系統就會刪除備份方案中最舊的備份,這些備份的總值已達到 `backup_retain_days` 和 `num_backups_to_retain`。如果未指定這項值,系統可能會根據「backup_retain_days」自動刪除依據這項備份方案建立的備份。create_timebackup_delete_lock_days are automatically deleted after the total number of backups under this backup plan reaches the value of更新這個欄位會影響備份方案下的現有備份。請注意,num_backups_to_retain 必須大於或等於 backup_delete_lock_days 內可建立的備份數量。 |
S3Options
定義呼叫備份存放區 S3 端點的選項。
顯示位置: - BackupRepositorySpec
| 欄位 | 說明 |
|---|---|
bucket 字串 |
端點內用於上傳備份的 bucket。 |
region 字串 |
指定端點的區域。格式化方式取決於儲存系統。 |
forcePathStyle boolean |
指定是否要強制使用物件的路徑樣式網址。例如:顯示 https://s3.amazonaws.com//,而不是 https://.s3.amazonaws.com/。 |
serverSideEncryption 字串 |
儲存物件時使用的伺服器端加密演算法。例如 AES256 oraws:kms`。 |
kmsKeyId 字串 |
如果伺服器端加密使用 KMS,則為用於物件儲存空間的 KMS 金鑰 ID。 |
排程
代表定義 Cron 排程的內部訊息類型。
顯示於: - BackupPlanSpec
| 欄位 | 說明 |
|---|---|
cronSchedule 字串 |
作業的執行排程 (以 Cron 字串表示)。 |
paused boolean |
指定排定作業是否處於非使用中或使用中狀態。如果設為 True,系統會停用排定的作業。預設值為 True。 |
maxConcurrency 整數 |
指定備份方案可同時擁有的有效定期備份數量上限。如果指定此值,則此備份方案中處於啟用狀態的排定備份數量,在任何時間點都不得超過此值。如未指定,則預設值為 2。 |
狀態
基礎類型: string
這個值會指定備份方案目前的狀態。
顯示位置: - BackupPlanStatus
SubstitutionRule
定義替代規則。
顯示於: - RestoreConfig
| 欄位 | 說明 |
|---|---|
target SubstitutionTarget |
比對條件:檢查資源是否為替代候選項目,以及是否有與提供的 JSONPath 值相符的欄位。 |
originValuePattern 字串 |
規則運算式模式字串,會套用至從提供的 Target 值比對到的 JSON 值。如未指定,系統一律會使用指定的 NewValue 值替換原始值。請注意,空字串是合法的 regex 模式,會像其他字串一樣處理。 |
newValue 字串 |
要代入的字串格式值。 |
SubstitutionTarget
定義替代目標候選人的規則。
顯示於: - SubstitutionRule
| 欄位 | 說明 |
|---|---|
namespaces 字串陣列 |
系統會將替代規則套用至目標命名空間清單。資源的原始命名空間必須與清單中的其中一個名稱相符,才會被視為替代候選項目。如要納入任何非命名空間資源,必須提供空白字串。如果留空,系統會將所有命名空間納入考量。 |
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 Group Kind 底下相同命名空間內的 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 參照。如果備份是磁碟備份,這個參照可能為空值 |
vmDiskRefs VMDisk 陣列 |
這項 CR 備份的 VM 磁碟清單 |
volumeBackupRefs 物件 (鍵:字串,值:VolumeBackup) |
將磁碟區備份名稱對應至這個備份下的 VolumeBackup 結構體。這項資料會嵌入 VMBackupJob,不會出現在叢集中 |
description 字串 |
備份的選填字串說明。這個欄位不會影響功能。 |
manual boolean |
指定備份資源是否為手動建立。如果 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 Condition 陣列 |
條件代表對這個 VMBackupJob 目前狀態的觀察結果。已知條件類型:已成功 |
createTime 時間 |
這個 VMBackupJob 資源的建立時間戳記。這項設定可轉換為 RFC 3339,也能從 RFC 3339 轉換而來。 |
snapshotTime 時間 |
VMBackupJob 資源中所有磁碟的快照時間戳記。這項設定可轉換為 RFC 3339,也能從 RFC 3339 轉換而來。 |
updateTime 時間 |
上次更新這個 VMBackupJob 的時間戳記。這項設定可轉換為 RFC 3339,也能從 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 磁碟所在的命名空間 |
name 字串 |
VM 磁碟名稱 |
pvcName 字串 |
基礎 PVC 的名稱 |
uid UID |
這個欄位用於取得特定 VMBackupJob 的 PVC UID |
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 |
磁碟區備份作業的來源永久磁碟區要求。 |
volumeBackupHandle 字串 |
基礎磁碟區備份控制代碼,可唯一識別磁碟區備份存放區內的磁碟區備份。這個控制代碼沒有統一格式,會被視為不透明字串。已淘汰:請改用狀態欄位。 |
VolumeBackupState
基礎型別: string
列舉,建議磁碟區備份的目前狀態。
顯示位置: - VolumeBackupStatus
VolumeBackupStatus
定義磁碟區備份的觀察狀態。
出現位置: - VolumeBackup
| 欄位 | 說明 |
|---|---|
volumeBackupHandle 字串 |
基礎磁碟區備份控制代碼,可唯一識別磁碟區備份存放區內的磁碟區備份。這個控制代碼沒有統一格式,會被視為不透明字串。 |
format VolumeBackupFormat |
磁碟區備份格式。例如 PD、Portable 等。 |
storageBytes 整數 |
備份儲存空間中的磁碟區備份大小。如果刪除先前的磁碟區備份,這個值可能會動態變更。 |
diskSizeBytes 整數 |
可還原這個磁碟區備份的磁碟最小大小。 |
state VolumeBackupState |
磁碟區備份的目前狀態。 |
message 字串 |
使用者可理解的訊息,說明備份處於此狀態的原因。 |
completeTime 時間 |
這個 VolumeBackup 資源完成的時間戳記,採用 RFC 3339 的文字格式。 |
errorStatus ErrorStatus |
最近發生的錯誤,包括觀察到的時間。 |
conditions Condition 陣列 |
「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 Condition 陣列 |
「Conditions」代表對這個磁碟區還原作業目前狀態的觀察結果。已知條件類型:就緒。 |
completeTime 時間 |
磁碟區還原程序的結束時間。 |
VolumeStrategy
基礎類型: string
備份磁碟區時使用的取捨方式。
顯示位置: - BackupConfig