4.3 还原点
4.3.3 创建备份还原点
响应示例
状态码： 200 OK
{ "replication" : {
"destination_vault_id" : "0ca3eb86-8800-46da-9c37-9d657a825274", "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66", "source_region" : "region1",
"vault_id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce", "destination_region" : "region2",
"destination_project_id" : "68589cac08274b82b4e254268a3862d8", "backups" : [ {
"replication_record_id" : "de128dfa-5451-4905-9c11-8fc842b2f41e", "backup_id" : "7558e1a3-7046-4787-95cd-14b0ad0642a8"
}, {
"replication_record_id" : "892a7d1e-17c8-4751-ad75-cfbed7051857", "backup_id" : "6df2b54c-dd62-4059-a07c-1b8f24f2725d"
}, {
"replication_record_id" : "8bf5ce8f-bfa1-4d57-98de-d6159ab9d86d", "backup_id" : "aa00034d-ef40-443d-ab7a-dc846d988cdf"
} ],
"project_id" : "4229d7a45436489f8c3dc2b1d35d4987"
}}
您可以在API Explorer中调试该接口。
URI
POST /v3/{project_id}/checkpoints
表4-88 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID
请求参数
表4-89 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。 通过调用IAM服务 获取用户Token接口获取（响应 消息头中X-Subject-Token的 值）。
表4-90 请求 Body 参数
参数 是否必选 参数类型 描述
checkpoint 是 VaultBackup
object 存储库执行备份参数
表4-91 VaultBackup
参数 是否必选 参数类型 描述
parameters 否 CheckpointP
aram object 参数
vault_id 是 String 存储库ID
表4-92 CheckpointParam
参数 是否必选 参数类型 描述
auto_trigger 否 Boolean 是否自动触发,true:自动触发，
false：非自动触发。
缺省值：false
参数 是否必选 参数类型 描述 description 否 String 备份描述
最小长度：0 最大长度：255
incremental 否 Boolean 是否增量备份，true:增量备份，
false：非增量备份。
缺省值：true
name 否 String 备份名称
最小长度：1 最大长度：64 resources 否 Array of
strings 待备份的资源id列表:uuid resource_deta
ils 否 Array of
Resource objects
资源详情
表4-93 Resource
参数 是否必选 参数类型 描述
extra_info 否 ResourceExtr
aInfo object 资源附加信息
id 是 String 待备份资源id
name 否 String 待备份资源名称，长度限制：
0-255 最小长度：0 最大长度：255
type 是 String 待备份资源的类型:
OS::Nova::Server, OS::Cinder::Volume,
OS::Ironic::BareMetalServer, OS::Native::Server,
OS::Sfs::Turbo
表4-94 ResourceExtraInfo
参数 是否必选 参数类型 描述
include_volu
mes 否 Array of
ResourceExtr aInfoInclude Volumes objects
指定需要备份的卷,若有指定 值，则每次备份都只备份指定的 卷，如虚拟机绑定存储库之后新 绑定的卷不会备份；若为空默认 为资源全部卷；仅虚拟机磁盘级 备份特性中有效。
表4-95 ResourceExtraInfoIncludeVolumes
参数 是否必选 参数类型 描述
id 是 String 卷ID，仅支持uuid
os_version 否 String 操作系统类型
响应参数
状态码： 200
表4-96 响应 Body 参数
参数 参数类型 描述
checkpoint CheckpointCr
eate object 还原点信息
表4-97 CheckpointCreate
参数 参数类型 描述
created_at String 创建时间，例如:"2020-02-05T10:38:34.209782"
id String 还原点ID
project_id String 项目ID
参数 参数类型 描述
status String 状态:available,deleting,protecting,deleted,error-deleting,error
枚举值：
● available
● deleting
● protecting
● deleted
● error-deleting
● error vault CheckpointPl
anCreate object
存储库信息
extra_info CheckpointEx traInfoResp object
表4-98 CheckpointPlanCreate
参数 参数类型 描述
id String 存储库id
name String 存储库名称
resources Array of CheckpointR esourceResp objects
备份对象
skipped_resou
rces Array of CheckpointCr eateSkipped Resource objects
备份时跳过的资源列表
表4-99 CheckpointResourceResp
参数 参数类型 描述
extra_info String 资源附加信息
id String 待备份资源id
name String 待备份资源名称
参数 参数类型 描述
protect_status String 保护状态。available（可用），error（错误），
protecting（备份中），restoring（恢复中），
removing（删除中）。
枚举值：
● available
● error
● protecting
● restoring
● removing
resource_size String 资源已分配容量,单位为GB
type String 待备份资源的类型: OS::Nova::Server,
OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo
backup_size String 副本大小 backup_count String 副本数量
表4-100 CheckpointCreateSkippedResource
参数 参数类型 描述
id String 资源ID
type String 资源类型
name String 资源名称
code String 请参见错误码。
reason String 跳过原因，例如：该资源正在备份中。
表4-101 CheckpointExtraInfoResp
参数 参数类型 描述
name String 备份名称
description String 备份描述 retention_dur
ation Integer 备份保留天数
请求示例
备份创建
POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/checkpoints { "checkpoint" : {
"parameters" : { "auto_trigger" : true,
"description" : "backup_description", "incremental" : true,
"name" : "backup_name",
"resources" : [ "94eba8b2-acc9-4d82-badc-127144cc5526" ] },
"vault_id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce"
}}
响应示例
状态码： 200
执行备份返回的checkpoint信息
{ "checkpoint" : { "status" : "protecting",
"created_at" : "2019-05-10T07:59:12.733403", "vault" : {
"skipped_resources" : [ ],
"id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce", "resources" : [ {
"name" : "ecs-1f0f-0002", "resource_size" : "40", "protect_status" : "available", "type" : "OS::Nova::Server",
"id" : "94eba8b2-acc9-4d82-badc-127144cc5526", "extra_info" : null
} ],
"name" : "vault-be94"
},
"project_id" : "4229d7a45436489f8c3dc2b1d35d4987", "id" : "8b0851a8-adf3-4f4c-a914-dead08bf9664", "extra_info" : {
"retention_duration" : -1, "name" : "backup_name",
"description" : "backup_description"
} }}
状态码
状态码 描述
200 执行备份返回的checkpoint信息
错误码
请参见错误码。