文档中心

云备份

API 参考

数据结构

数据结构

本文介绍不同类型备份源的备份、恢复参数。

ECS 整机

备份参数

Volume

参数名	类型	是否必填	示例	参数描述
VolumeId	String	是	vol-3wp2rg3oac4kgzvc****	云盘 ID。

EcsBackupConfiguration

参数名	类型	是否必填	示例	参数描述
VolumeList	Array of Volume	是	[{"VolumeId":"vol-3wp2rg3oac4kgzvc****"}]	云盘列表。
AutoBackupAllAttachedVolumes	Bool	是	true	是否需要备份 ECS 实例上的所有云盘，取值说明如下： true：备份 ECS 实例上的所有云盘。 false：只备份 VolumeList 参数中指定的云盘。

恢复参数

EcsRestoreConfiguration

参数名	类型	是否必填	示例	参数描述
SnapshotIdList	Array of String	是	["snap-3wpbjri9yx55inqo****"]	待恢复的快照列表。
SnapshotGroupId	String	是	sg-3wpbjri9yx55inqo****	快照一致性组 ID。
AutoStartUpAfterRecovery	Bool	否	true	恢复成功后是否自动开机。取值说明如下： true：自动开机。 false：不自动开机。

恢复点元数据

Snapshot

参数名	类型	是否必填	示例	参数描述
VolumeId	String	是	vol-3wp2rg3oac4kgzvc****	云盘 ID。
SnapshotId	String	是	snap-3wpbjri9yx55inqo****	快照 ID。

EcsRecoveryPointMeta

参数名	类型	是否必填	示例	参数描述
SnapshotList	Array of Snapshot	是	[{"SnapshoId":"snap-3wpbjri9yx55inqo**","VolumeId":"vol-3wp2rg3oac4kgzvc**"}]	备份的快照列表。
SnapshotGroupId	String	是	snap-3wpbjri9yx55inqo****	快照一致性组 ID。

vePFS

备份参数

PathItem

参数名	类型	是否必填	示例	参数描述
FileSetId	String	否	fset-xxxxx	如果路径位于 fileset，需要用此字段指定 fileset id。
FileSetPath	String	否	/cbr-dev-bytecycle	如果路径位于 fileset，需要用此字段指定 fileset path。
Path	String	是	/	路径详情，说明如下：未指定 FileSetId 参数时，此字段用于指定绝对路径。指定 FileSetId 参数时，此字段用于指定 fileset下的相对路径。

VePFSBackupConfiguration

参数名	类型	是否必填	示例	参数描述
PathList	Array of PathItem	是	[{\"FileSetId\":\"fset-xxxxxx\",\"Path\":\"/\",\"FileSetPath\":\"/cbr-dev-xxxxx\"}]	备份的路径列表，格式为 JSON String。
VaultBucket	String	是	my-vault-name	备份库名称。

恢复参数

VepfsRestoreConfiguration

参数名	类型	是否必填	示例	参数描述
RestoreType	Array of PathItem	是	ALL	恢复类型，取值说明如下： ALL：恢复全部文件。 INCLUDE：恢复 PathList 参数指定的文件。 EXCLUDE：执行恢复操作时，排除 PathList 参数指定的文件，恢复其余文件。
PathList	Array of PathItem	是	[{\"FileSetId\":\"fset-xxxxxx\",\"Path\":\"/\",\"FileSetPath\":\"/cbr-dev-xxxxx\"}]	备份的路径列表，格式为 JSON String。
TargetInstanceType	String	是	ORIGIN	恢复的目标实例，当前仅支持取值为 ORIGIN，表示恢复至 vePFS 实例。
TargetInstanceId	String	否	vepfs-cnbjbbd8d40e****	恢复的 vePFS 实例 ID。
TargetPathType	String	是	ORIGIN	恢复路径的方式，取值说明如下： ORIGIN：恢复至原路径。 PATH：恢复至其他路径，采用绝对路径方式指定路径。
TargetPathItem	String	否	/newpath/	具体恢复路径。说明仅当 TargetPathType 为 PATH 时，该参数有效。
ConflictPolicy	String	是	OVERWRITE	同名文件处理策略，取值说明如下： SKIP：跳过同名文件。 OVERWRITE：覆盖恢复路径同名文件。 KEEP_LATEST：比较文件的更新时间，保留最新版本的文件。

恢复点元数据

VepfsRecoveryPointMeta

参数名	类型	是否必填	示例	参数描述
PathList	Array of PathItem	是	[{\"FileSetId\":\"fset-xxxxxx\",\"Path\":\"/\",\"FileSetPath\":\"/cbr-dev-xxxxx\"}]	备份的路径列表，格式为 JSON String。
VaultBucket	String	是	my-vault-name	备份库名称。

最近更新时间：2025.10.31 14:10:14

这个页面对您有帮助吗？

有用

有用

无用

无用