文档首页/ 云服务器备份 CSBS/ API参考（巴黎、阿姆斯特丹区域）/ API说明/ 备份管理/ 查询所有备份

更新时间：2022-02-22 GMT+08:00

查询所有备份

功能介绍

查询所有备份，支持过滤参数查询。

URI

URI
GET https://{endpoint}/v1/{project_id}/checkpoint_items

参数说明

表1 参数说明
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。获取方法请参见获取项目ID。

请求

查询参数说明

表2 查询参数说明
参数	是否必选	参数类型	描述
status	否	String	支持根据status字段查询取值范围:[ waiting_protect, protecting, available, waiting_restore, restoring, error, waiting_delete, deleting,deleted]
limit	否	Integer	每页显示的条目数量，正整数，默认值1000
marker	否	String	上一次查询最后一条的ID
sort	否	String	sort的内容为一组由逗号分隔的属性及可选排序方向组成，形如<key1>[:<direction>],<key2>[:<direction>],其中direction的取值为asc (升序) 或 desc (降序),如没有传入direction参数，默认为降序，sort内容的长度限制为255个字符，key的枚举值：[created_at, updated_at, name, status, protected_at, id].
all_tenants	否	Boolean	是否查询所有租户的备份，只有管理员权限用户能查询所有租户备份
name	否	String	支持根据备份name字段模糊查询
az	否	String	支持按备份az来过滤
resource_id	否	String	支持按照备份对象ID过滤
resource_name	否	String	支持按照备份对象名称模糊查询
start_time	否	String	支持按照备份时间过滤，过滤起始时间点如:"2017-04-18T01:21:52.701973"
end_time	否	String	支持按照备份时间过滤，过滤结束时间点如:"2017-04-18T01:21:52.701973"
image_type	否	String	支持按照备份镜像类型过滤，如：backup
policy_id	否	String	支持按照policy_id过滤
offset	否	Integer	偏移值，正整数
checkpoint_id	否	String	支持按照checkpoint_id过滤
resource_type	否	String	备份对象的类型，如："OS::Nova::Server"

要素说明
 无

请求样例

查询所有备份
GET https://{endpoint}/v1/{project_id}/checkpoint_items
带参数查询
GET https://{endpoint}/v1/{project_id}/checkpoint_items?name=backup&status=error&limit=2

响应

要素说明

表3 要素说明
参数	参数类型	描述
checkpoint_items	List<checkpoint_item>	-

checkpoint_item 字段数据结构说明

表4 checkpoint_item 字段数据结构说明
参数	参数类型	描述
checkpoint_id	String	备份记录ID
created_at	String	创建时间,如:"2017-04-18T01:21:52.701973"
extend_info	Dict	扩展信息
id	String	备份ID
name	String	备份名称
resource_id	String	备份对象ID
status	String	备份状态waiting_protect,protecting,available,waiting_restore,restoring,error,waiting_delete,deleting,deleted Enum:[ waiting_protect, protecting, available, waiting_restore, restoring, error, waiting_delete, deleting,deleted]
updated_at	String	修改时间,如:"2017-04-18T01:21:52.701973"
backup_data	Dict	虚拟机元数据
description	string	备份描述信息
resource_type	String	备份对象的类型

extend_info 字段数据结构说明

表5 extend_info 字段数据结构说明
参数	参数类型	描述
auto_trigger	Boolean	是否自动触发
average_speed	Integer	平均速率，单位为：kb/s
copy_from	String	备份复制于那个region，默认为空
copy_status	String	备份的复制状态，默认为na 取值范围为：na, waiting_copy, copying, success, fail。
fail_code	fail_code	错误码
fail_op	String	失败的操作类型 Enum: [backup, restore, delete]
fail_reason	String	失败原因英文描述
image_type	String	备份类型，如：backup
incremental	Boolean	是否为增强备份
progress	Integer	进度，整数，取值范围为：0-100
resource_az	String	备份资源所属az
resource_name	String	备份对象名称
resource_type	String	备份对象的类型，如："OS::Nova::Server"
size	Integer	备份容量，以MB为单位
space_saving_ratio	Integer	空间节省率
volume_backups	List<volume_backup>	卷备份列表
finished_at	String	备份完成时间,如:"2017-04-18T01:21:52.701973"
supported_restore_mode	String	备份支持恢复的方式，当前取值包含na,snapshot和backup。如果该字段取值为snapshot，代表备份此时已经支持创建整机镜像；如果该字段取值为backup，备份支持通过云服务器上硬盘的备份进行恢复；如果该字段取值为na，备份不支持恢复。
os_images_data	List<image_data>	镜像数据，虚拟机创建过镜像时有值
support_lld	Boolean	是否支持lazyloading快速恢复
taskid	String	任务ID
hypervisor_type	String	虚拟化类型。取值为QEMU，表示虚拟机技术。

image_data字段数据结构说明

表6 image_data字段数据结构说明
参数	参数类型	描述
image_id	String	镜像ID

backup_data 字段数据结构说明

表7 backup_data 字段数据结构说明
参数	参数类型	描述
__openstack_region_name	String	云服务器所在可用分区名称，为空时表示未获取到服务器该信息。
cloudservicetype	String	云服务器类型
disk	Integer	该云服务器规格对应要求系统盘大小
imagetype	String	镜像类型gold：公共镜像private：私有镜像market：市场镜像 Enum: [gold, private, market]
ram	Integer	该云服务器的内存大小，单位为MB
vcpus	Integer	该云服务器对应的cpu核数
eip	String	云服务器弹性IP，为空时表示未获取到服务器该信息。
private_ip	String	云服务器内部IP，为空时表示未获取到服务器该信息。

fail_code 字段数据结构说明

表8 fail_code 字段数据结构说明
参数	参数类型	描述
Code	Long	错误码
Description	String	错误描述

volume_backup 字段数据结构说明

表9 volume_backup 字段数据结构说明
参数	参数类型	描述
average_speed	Integer	平均速率，单位为MB/s。
bootable	Boolean	是否系统盘。取值为True或者False。
id	String	cinder backup id
image_type	String	备份集类型，备份 Enum:[ backup]
incremental	Boolean	是否增备
name	String	卷备份名称
size	Integer	累计备份大小，单位是MB
source_volume_id	String	源卷ID
source_volume_size	Integer	源卷大小（GB）
space_saving_ratio	Integer	空间节省率
status	String	状态
source_volume_name	String	源卷名称
snapshot_id	String	生成备份的快照ID

响应样例

{
  "checkpoint_items" : [ {
    "status" : "available",
    "backup_data" : {
      "eip" : "",
      "cloudservicetype" : "",
      "ram" : 4096,
      "vcpus" : 4,
      "__openstack_region_name" : "",
      "private_ip" : "",
      "disk" : 0,
      "imagetype" : ""
    },
    "name" : "backup_d32c",
    "resource_id" : "f45c477a-57e5-465f-999f-d845083962db",
    "created_at" : "2017-04-15T04:20:37.277880",
    "checkpoint_id" : "f672a1bb-6912-446a-816c-72792c5263e0",
    "updated_at" : "2017-04-15T04:25:38.680638",
    "resource_type": "OS::Nova::Server",
    "extend_info" : {
      "auto_trigger" : false,
      "space_saving_ratio" : 0,
      "copy_status" : "na",
      "fail_reason" : "",
      "resource_az" : "az1.dc1",
      "image_type" : "backup",
      "finished_at" : "2017-04-15T04:25:38.675478",
      "average_speed" : 0,
      "copy_from" : "",
      "supported_restore_mode": "backup",
      "support_lld": false,
      "os_images_data": [
            {
                "image_id": "fe84dd80-0229-4918-8d3d-cbb33154b565"
            }
       ],
      "volume_backups" : [ {
        "status" : "available",
        "space_saving_ratio" : 0,
        "name" : "manualbk_47222",
        "bootable" : true,
        "average_speed" : 0,
        "source_volume_size" : 20,
        "source_volume_id" : "ee27f809-6fb5-40ae-ac46-c932bb4ee8fe",
        "incremental" : false,
        "image_type" : "backup",
        "source_volume_name" : "karbor_xj_02",
        "id" : "70675cbc-d3a8-43a7-9f81-c8b6bc3f5d6d",
        "size" : 0,
        "snapshot_id": "36f520e1-d2ea-4907-956a-3d9cd53e2d38"
      }, {
        "status" : "available",
        "space_saving_ratio" : 0,
        "name" : "manualbk_47222",
        "bootable" : true,
        "average_speed" : 0,
        "source_volume_size" : 20,
        "source_volume_id" : "e7f48980-927c-48de-afd4-f0245d2e5100",
        "incremental" : false,
        "image_type" : "backup",
        "source_volume_name" : "karbor_01",
        "id" : "8eb98e91-8924-4d4b-b6d6-28fb7b751e9c",
        "size" : 0,
        "snapshot_id": "36f520e1-d2ea-4907-956a-3d9cd53e2d38"
      } ],
      "fail_code" : { },
      "incremental" : false,
      "taskid" : "e0a21692-2192-11e7-bf23-0242ac110007",
      "hypervisor_type" : "QEMU",
      "progress" : 100,
      "fail_op" : "",
      "resource_name" : "karbor_02",
      "size" : 0
    },
    "id" : "90c1d5fa-1b9f-4aeb-b2f4-81c806e98190"
  } ]
}

状态码

正常

状态码

说明

200

OK

状态码	说明
200	OK

异常

状态码	说明
400	请求参数不合法
401	鉴权失败
403	没有操作权限
404	请求对象不存在
500	服务内部错误
503	服务不可用

错误码

请参考错误码。

父主题： 备份管理

上一篇：查询单个备份

下一篇：删除备份

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消