创建备份还原点 - CreateCheckpoint

project_id

是

String

参数解释：

项目ID，获取方法请参见获取项目ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

X-Auth-Token

是

String

参数解释：

用户Token。用于鉴权验证，确认调用者身份和权限。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

checkpoint

是

VaultBackup object

参数解释：

用于指定创建备份还原点所需的存储库及备份参数信息。

约束限制：

不涉及

parameters

否

CheckpointParam object

参数解释：

用于配置备份的详细参数，包括是否自动触发、备份描述、是否增量备份等。

约束限制：

不涉及

vault_id

是

String

参数解释：

存储库ID，用于指定执行备份操作的存储库。

获取方法请参见"获取存储库ID"。

约束限制：

不涉及

取值范围：

格式为UUID

默认取值：

不涉及

auto_trigger

否

Boolean

参数解释：

是否自动触发。

约束限制：

不涉及

取值范围：

• true：自动触发

• false：非自动触发

默认取值：

false

description

否

String

参数解释：

备份描述。

约束限制：

不能包含“<”和“>”字符。

取值范围：

最大支持255个字符。

默认取值：

不涉及

incremental

否

Boolean

参数解释：

是否增量备份。

约束限制：

不涉及

取值范围：

• true：增量备份

• false：非增量备份

默认取值：

true

name

否

String

参数解释：

备份名称。

约束限制：

不涉及

取值范围：

只能由数字、中文、英文大小写字母、下划线"_"和中横线"-"组成，最大支持64个字符。

默认取值：

不涉及

resources

否

Array of strings

参数解释：

待备份的资源ID列表，列表元素为String类型的UUID。

获取方法请参见"查询存储库绑定资源信息"，"查询资源可保护性"。

约束限制：

需要该资源已经绑定到该存储库中，且属于可备份的状态。

取值范围：

不涉及

默认取值：

不涉及

resource_details

否

Array of Resource objects

参数解释：

待备份资源的详细信息列表，列表元素为Resource对象，包含资源ID、名称、类型等。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

retention_duration_days

否

Integer

参数解释：

手动备份的保留时长，单位为天。设置该参数后，备份副本将在保留时长到期后自动删除。用于为手动备份设置自动过期时间，避免手动备份堆积导致存储容量浪费。不设置此参数时，备份将永久保留。

约束限制：

当auto_trigger为true时不支持传此参数，自动备份的保留时间由关联的备份策略指定。auto_trigger不传或为false时支持指定此参数。

取值范围：

• 1~36500：指定保留天数，备份将在创建时间 + 该天数后到期并自动删除。

• -1：永久保留，备份不会自动过期。

默认取值：

-1

extra_info

否

ResourceExtraInfo object

参数解释：

资源附加信息

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

id

是

String

参数解释：

待备份资源ID，用于标识需要备份的资源。

获取方法请参见"查询存储库绑定资源信息"，"查询资源可保护性"。

约束限制：

需要该资源已经绑定到该存储库中，且属于可备份的状态。

取值范围：

格式为UUID

默认取值：

不涉及

name

否

String

参数解释：

待备份资源名称，用于标识待备份的资源名称。

约束限制：

不涉及

取值范围：

长度为0~255个字符。

默认取值：

不涉及

type

是

String

参数解释：

待备份资源的类型，用于指定待备份的资源类型，不同类型对应不同的云服务资源。

约束限制：

不涉及

取值范围：

OS::Nova::Server：云服务器； OS::Cinder::Volume：云硬盘；OS::Ironic::BareMetalServer：裸金属服务器；OS::Sfs::Turbo：SFS Turbo文件系统；OS::Workspace::DesktopV2：云桌面。

默认取值：

不涉及

exclude_volumes

否

Array of strings

参数解释：

需要排除备份的卷ID列表，列表元素为String类型的UUID。

约束限制：

仅在多盘备份特性中有效，排除不需要备份的磁盘。当虚拟机新绑定磁盘时，也能继续排除之前设置不用备份的卷。

取值范围：

不涉及

默认取值：

不涉及

checkpoint

CheckpointCreate object

参数解释：

创建备份后返回的还原点信息，包含还原点ID、状态、关联存储库等。

取值范围：

不涉及

created_at

String

参数解释：

创建时间，使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ss.SSSSSS。

取值范围：

不涉及

id

String

参数解释：

还原点ID。

取值范围：

格式为UUID

project_id

String

参数解释：

项目ID。

取值范围：

不涉及

status

String

参数解释：

还原点状态

取值范围：

• available: 可用

• deleting: 删除中

• protecting: 保护中

• deleted: 已删除

• error-deleting:删除异常

• error: 异常

vault

CheckpointPlanCreate object

参数解释：

备份还原点关联的存储库信息，包含存储库ID、名称、备份资源等。

取值范围：

不涉及

extra_info

CheckpointExtraInfoResp object

参数解释：

备份还原点的扩展信息，包含备份名称、描述、保留天数等。

取值范围：

不涉及

id

String

参数解释：

存储库ID。

取值范围：

格式为UUID

name

String

参数解释：

存储库名称。

取值范围：

只能由中文、字母、数字、“_”、“-”组成，最大支持64个字符。

resources

Array of CheckpointResourceResp objects

参数解释：

存储库中备份资源的信息列表，列表元素为CheckpointResourceResp对象，包含资源ID、名称、类型、保护状态等。

取值范围：

不涉及

skipped_resources

Array of CheckpointCreateSkippedResource objects

参数解释：

备份时跳过的资源列表，列表元素为CheckpointCreateSkippedResource对象，包含跳过资源的ID、类型和原因等信息。

取值范围：

不涉及

extra_info

String

参数解释：

资源附加信息。

取值范围：

不涉及

id

String

参数解释：

待备份资源ID。

取值范围：

格式为UUID

name

String

参数解释：

待备份资源名称。

取值范围：

长度为0~255个字符。

protect_status

String

参数解释：

保护状态

取值范围：

• available: 可用

• error: 异常

• protecting: 保护中

• restoring: 恢复中

• removing: 删除中

resource_size

String

参数解释：

资源已分配容量，单位为GB。

取值范围：

不涉及

type

String

参数解释：

待备份资源的类型，用于指定待备份的资源类型，不同类型对应不同的云服务资源。

取值范围：

OS::Nova::Server：云服务器； OS::Cinder::Volume：云硬盘；OS::Ironic::BareMetalServer：裸金属服务器；OS::Sfs::Turbo：SFS Turbo文件系统；OS::Workspace::DesktopV2：云桌面。

backup_size

String

参数解释：

备份副本大小，单位GB。

取值范围：

不涉及

backup_count

String

参数解释：

副本数量。

取值范围：

不涉及

id

String

参数解释：

资源ID。可根据待备份的资源类型查询对应的资源情况。

取值范围：

格式为UUID

type

String

参数解释：

资源类型。

取值范围：

OS::Nova::Server：云服务器；OS::Cinder::Volume：云硬盘；OS::Ironic::BareMetalServer：裸金属服务器；OS::Sfs::Turbo：SFS Turbo文件系统；OS::Workspace::DesktopV2：云桌面

name

String

参数解释：

待备份资源名称。

取值范围：

长度为0~255个字符。

code

String

参数解释：

跳过资源时返回的错误码，用于标识具体的错误类型，请参见错误码。

取值范围：

不涉及

reason

String

参数解释：

跳过原因，例如：该资源正在备份中。

取值范围：

不涉及

name

String

参数解释：

备份名称。

取值范围：

不涉及

description

String

参数解释：

备份描述

取值范围：

不涉及

retention_duration

Integer

参数解释：

备份保留天数，单位：天。

取值范围：

不涉及

200

OK