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、所选命名空间和所选应用。您必须为 backup_scope 指定单个值。BackupScope 值必须是以下类型之一：BackupConfig_AllNamespaces、BackupConfig_SelectedNamespaces 或 BackupConfig_SelectedApplications。
backupRepository 字符串 用于标识相应 BackupPlan 资源的辅助存储空间的 BackupRepository 资源的名称。
includeVolumeData 布尔值 指定是否备份卷数据。如果未设置，则默认值为 False。
includeSecrets 布尔值 指定是否备份 Secret。如果未设置，则默认值为 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，则创建的 BackupRepository 将为“ReadWrite”。如果要在 ReadOnlyClusters 列表中存在的集群中创建该资源，则该值为“ReadOnly”。该字段不可更改。
readWriteCluster NamespacedName ReadWriteCluster 指定了有权使用 BackupRepositorySpec 字段中的数据创建 ReadWrite 备份库的单个集群 (baremetal.cluster.gke.io/Cluster)。ReadWrite 存储库可用于安排/创建备份、备份方案和恢复，并且实际上归创建它的集群所有。注意：一个 BackupRepository 最多只能被一个 k8s 集群用作 ReadWrite。此字段可更改。
readOnlyClusters NamespacedName 数组 ReadOnlyClusters 指定了有权使用 BackupRepositorySpec 字段中的数据创建只读备份库的集群 (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 数组中相应条目的“就绪”条件将为“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，新的备份代码库仍会通过将其自己的 sentinel 文件替换现有的 sentinel 文件来声明对存储桶的所有权。如果值为 False，则新备份代码库的创建会失败并显示错误。默认值为 False。只有在被替换的 Sentinel 文件不再具有备份代码库时，才能使用此属性，否则该备份代码库会进入错误状态，可能会导致不良的副作用。

BackupRepositoryStatus

定义备份存储库的观测状态。

来源： - BackupRepository

字段 说明
sentinelEtag 字符串 用于将备份代码库与其拥有的 sentinel 文件相关联的字段。
reconciliationError ReconciliationError 备份代码库的最近一次协调尝试期间发生的错误。
reconciliationErrorMessage 字符串 对账期间可能发生的错误消息。
errorStatus ErrorStatus 包括与观测时间进行对账后发现的最新错误。
initialImportDone 布尔值 指定相应备份库是否已完成初始导入。
conditions 条件数组 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 布尔值 指定是否备份所有命名空间。如果设置为 True，则表示必须备份所有命名空间。
selectedNamespaces 命名空间 要备份的命名空间列表。
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、所选命名空间和所选应用。您必须为 backup_scope 指定单个值。BackupScope 值必须是以下类型之一：BackupConfig_AllNamespaces、BackupConfig_SelectedNamespaces 或 BackupConfig_SelectedApplications。
backupRepositoryName 字符串 用于标识相应 ClusterBackupPlan 资源的辅助存储空间的 BackupRepositoryRef 资源的名称。
clusterBackupRepositoryName 字符串 用于标识相应 ClusterBackupPlan 资源的辅助存储空间的 ClusterBackupRepositoryRef 资源的名称。
includeVolumeData 布尔值 指定是否备份卷数据。如果未设置，则默认值为 false。
includeSecrets 布尔值 指定是否备份 Secret。如果未设置，则默认值为 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，新的备份代码库仍会通过将其自己的 sentinel 文件替换现有的 sentinel 文件来声明对存储桶的所有权。如果值为 False，则新备份代码库的创建会失败并显示错误。默认值为 False。只有在被替换的 Sentinel 文件不再具有备份代码库时，才能使用此属性，否则该备份代码库会进入错误状态，可能会导致不良的副作用。

ClusterBackupRepositoryStatus

定义 ClusterBackupRepository 资源的观测状态。

来源： - ClusterBackupRepository

字段 说明
sentinelEtag 字符串 用于将备份代码库与其拥有的 sentinel 文件相关联的字段。
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 发生冲突时，非命名空间型集群资源要遵循的恢复行为。

来源： - 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 条件数组 指定集群恢复的状态。支持的条件包括 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 字符串 关联备份的名称。每个集群卷备份都必须与一个备份相关联。它将始终位于同一命名空间中。
clusterBackupPlanName 字符串 创建关联备份时所依据的备份方案的名称。它将始终位于同一命名空间中。
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 的架构。

Appears in: - 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 数组 从恢复中排除资源。如果指定，则当资源与 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 资源相同的命名空间内创建的。
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 布尔值 指定是否恢复备份中的所有命名空间型资源。如果未指定此字段，或者将其设置为 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 布尔值 指定是否将每次转移存储在存储桶中带有时间戳的子路径中。如果设置为 True，则结构为 YYYY-MM-DD-hh:mm:ss。这有助于存储在多个时间点创建的备份副本。默认值为 False。

ObjectStorageEndpoint

表示对象存储端点以及用于访问该端点的凭据。

来源： - ObjectStorageBackupConfig

字段 说明
endpoint 字符串 用于访问对象存储的端点。例如 https://s3.svc。
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 字符串 备份代码库的 T 名称，用于标识恢复资源的相应代码库。此字段必须以读写模式附加。请注意，此备份仓库可能与此恢复所引用的备份的备份仓库不同。如果未提供此字段，则系统将使用以下逻辑进行选择：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 条件数组 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 布尔值 指定是否强制为对象使用路径样式网址。例如，显示的是 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 字符串数组 应用替换规则的目标命名空间列表。资源的原始命名空间必须与列表中的某个名称一致，才能被视为替换候选对象。如需考虑任何非命名空间资源，必须提供一个空字符串。如果为空，则考虑所有命名空间。
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 Patch 表示法（适用于某些操作）。
value 字符串 要用于转换的字符串格式的目标值。

TransformationRuleOperation

底层类型： string 转换规则的预期操作。

来源： - TransformationRuleAction

VMBackupJobList

包含备份列表。

字段 说明
apiVersion 字符串 backup.gdc.goog/v1
kind 字符串 VMBackupJobList
metadata ListMeta 如需了解 metadata 的字段，请参阅 Kubernetes API 文档。
items VMBackupJob 数组

VMBackupJobSpec

定义备份的期望状态。

来源： - VMBackupJob

字段 说明
backupRef NamespacedName 虚拟机备份作业所关联的控制平面备份名称。该名称不可变。
vmRef NamespacedName 相应 CR 正在备份的虚拟机的引用。如果备份是磁盘备份，则此引用可能为 nil
vmDiskRefs VMDisk 数组 相应 CR 备份的虚拟机磁盘列表
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 整数 备份相应虚拟机/虚拟机磁盘所需的重试总次数
deleteLockExpireTime 时间 删除锁的过期时间。这是一个仅输出字段，通过 create_time 和 delete_lock_days 的组合值进行计算，会在备份的 delete_lock_days 字段更新时进行相应更新。请注意，此字段仅适用于处于 Succeeded 状态的备份。
retainExpireTime 时间 备份自动删除的时间。这是一个仅输出字段，通过 create_time 和 retain_days 的组合值进行计算，会在备份的 retain_days 字段更新时进行相应更新。
completeTime 时间 备份的完成时间。

VMDisk

来源： - VMBackupJobSpec

字段 说明
namespace 字符串 虚拟机磁盘所在的命名空间
name 字符串 虚拟机磁盘的名称
pvcName 字符串 底层 PVC 的名称
uid UID 相应 PVC 的 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 从中获取卷备份的源永久性卷声明。
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 表示相应卷恢复的当前状态的观测结果。已知条件类型：就绪。
completeTime 时间 卷恢复流程的结束时间。

VolumeStrategy

底层类型： string 备份卷时使用的权衡。

来源： - BackupConfig