创建备份还原点 - CreateCheckpoint

功能介绍

对存储库执行备份，生成备份还原点

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

POST /v3/{project_id}/checkpoints

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，默认取值不涉及。获取方法请参见"获取项目ID"。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。默认取值不涉及。

表3 请求Body参数
参数	是否必选	参数类型	描述
checkpoint	是	VaultBackup object	存储库执行备份参数

表4 VaultBackup
参数	是否必选	参数类型	描述
parameters	否	CheckpointParam object	存储库执行备份参数详情
vault_id	是	String	存储库ID，默认取值不涉及。获取方法请参见"获取存储库ID"。

表5 CheckpointParam
参数	是否必选	参数类型	描述
auto_trigger	否	Boolean	功能说明：是否自动触发。默认为false。取值范围： true:自动触发 false：非自动触发
description	否	String	备份描述，不能包含“<”，“>”，最大支持255个字符。默认取值不涉及。
incremental	否	Boolean	功能说明：是否增量备份，默认值为true 取值范围： true:增量备份 false：非增量备份
name	否	String	备份名称，最大支持64字符，只能由数字、中文、英文大小写字母，以及下划线"_"和中横线 "-" 字符构成。默认取值不涉及。
resources	否	Array of strings	待备份的资源id列表:uuid，需要该资源已经绑定到该存储库中，且属于可备份的状态。默认取值不涉及。获取方法请参见"查询存储库绑定资源信息"，"查询资源可保护性"。
resource_details	否	Array of Resource objects	待备份的资源详情

表6 Resource
参数	是否必选	参数类型	描述
extra_info	否	ResourceExtraInfo object	资源附加信息
id	是	String	待备份资源id，需要该资源已经绑定到该存储库中，且属于可备份的状态。默认取值不涉及。获取方法请参见"查询存储库绑定资源信息"，"查询资源可保护性"。
name	否	String	待备份资源名称，长度限制：0-255字符。默认取值不涉及。
type	是	String	待备份资源的类型: OS::Nova::Server：云服务器； OS::Cinder::Volume：云硬盘；OS::Ironic::BareMetalServer：裸金属服务器；OS::Sfs::Turbo：SFS Turbo文件系统；OS::Workspace::DesktopV2：云桌面。默认取值不涉及。

表7 ResourceExtraInfo
参数	是否必选	参数类型	描述
exclude_volumes	否	Array of strings	需要排除备份的卷id。仅在多盘备份特性中有效，排除不需要备份的磁盘。当虚拟机新绑定磁盘时，也能继续排除之前设置不用备份的卷。默认取值不涉及。

响应参数

状态码：200

表8 响应Body参数
参数	参数类型	描述
checkpoint	CheckpointCreate object	备份还原点信息

表9 CheckpointCreate
参数	参数类型	描述
created_at	String	创建时间，例如:"2020-02-05T10:38:34.209782"。
id	String	还原点ID。获取方法请参见"创建备份还原点", "查询所有备份"。
project_id	String	项目ID。获取方法请参见"获取项目ID"。
status	String	还原点状态，取值范围如下： available: 可用 deleting: 删除中 protecting: 保护中 deleted: 已删除 error-deleting:删除异常 error: 异常
vault	CheckpointPlanCreate object	存储库信息
extra_info	CheckpointExtraInfoResp object	扩展信息

**表10** CheckpointPlanCreate
参数	参数类型	描述
id	String	存储库ID。获取方法请参见"获取存储库ID"。
name	String	存储库名称，最大支持64字符，只能由中文、字母、数字、“_”、“-”组成。
resources	Array of CheckpointResourceResp objects	备份对象
skipped_resources	Array of CheckpointCreateSkippedResource objects	备份时跳过的资源列表

**表11** CheckpointResourceResp
参数	参数类型	描述
extra_info	String	资源附加信息
id	String	待备份资源id，需要该资源已经绑定到该存储库中，且属于可备份的状态。获取方法请参见"查询存储库绑定资源信息"，"查询资源可保护性"。
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	副本数量，取值范围不涉及，默认取值不涉及。

**表12** CheckpointCreateSkippedResource
参数	参数类型	描述
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	跳过原因，例如：该资源正在备份中。

**表13** CheckpointExtraInfoResp
参数	参数类型	描述
name	String	备份名称，最大支持64字符，只能由数字、中文、英文大小写字母，以及下划线"_"和中横线 "-" 字符构成。
description	String	备份描述，取值范围不涉及。
retention_duration	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" : {
    "status" : "protecting",
    "created_at" : "2019-05-10T07:59:12.733+00:00",
    "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"
      } ],
      "name" : "vault-be94"
    },
    "project_id" : "4229d7a45436489f8c3dc2b1d35d4987",
    "id" : "8b0851a8-adf3-4f4c-a914-dead08bf9664",
    "extra_info" : {
      "retention_duration" : -1,
      "name" : "backup_name",
      "description" : "backup_description"
    }
  }
}