文档首页/ 云备份 CBR/ API参考（安卡拉区域）/ API/ 备份/ 查询所有备份
更新时间：2024-04-19 GMT+08:00
查看PDF
分享

查询所有备份

功能介绍

查询所有副本

URI

GET /v3/{project_id}/backups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID
表2 Query参数

参数

是否必选

参数类型

描述

checkpoint_id

否

String

还原点ID

dec

否

Boolean

专属云 （专属云场景使用，非专属云场景不生效）

end_time

否

String

备份产生时间范围的结束时间，格式为%YYYY-%mm-%ddT%HH:%MM:%SSZ，例如2018-02-01T12:00:00Z

enterprise_project_id

否

String

企业项目id或all_granted_eps，all_granted_eps表示查询用户有权限的所有企业项目id

image_type

否

String

|-

incremental

否

Boolean

是否是增备

缺省值：false

limit

否

Integer

每页显示的条目数量，正整数

marker

否

String

上一次查询最后一条的id

member_status

否

String

共享状态

枚举值：

  • pending

  • accepted

  • rejected

name

否

String

名称

offset

否

Integer

偏移值，正整数

own_type

否

String

持有类型，私有的private/共享的shared/全部all_granted，默认只查询private。

缺省值：private

枚举值：

  • all_granted

  • private

  • shared

parent_id

否

String

父备份ID

resource_az

否

String

支持按az来过滤

resource_id

否

String

资源ID

resource_name

否

String

资源名称

resource_type

否

String

|-

sort

否

String

sort的内容为一组由逗号分隔的属性及可选排序方向组成，形如<key1>[:<direction>],<key2>[:<direction>],其中direction的取值为asc (升序) 或 desc (降序),如没有传入direction参数，默认为降序，sort内容的长度限制为255个字符。key取值范围:[created_at，updated_at，name，status，protected_at，id]

start_time

否

String

备份产生时间范围的开始时间，格式为%YYYY-%mm-%ddT%HH:%MM:%SSZ，例如2018-02-01T12:00:00Z

status

否

String

状态。 调用API时，支持通过传多个status值进行过滤。例如：status=available&status=error

枚举值：

  • available

  • protecting

  • deleting

  • restoring

  • error

  • waiting_protect

  • waiting_delete

  • waiting_restore

used_percent

否

String

根据存储库使用率过滤备份，取值范围 [1, 100]，含1和100。例如，used_percent=80，表示筛选所属存储库使用率大于等于80%的所有备份。

vault_id

否

String

存储库ID

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

backups

Array of BackupResp objects

备份列表

count

Integer

备份个数

offset

Integer

偏移量，表示从此偏移量开始查询

最小值：0

缺省值：0

limit

Integer

每页显示的条目数量

最小值：1

最大值：1000

缺省值：1000
表5 BackupResp

参数

参数类型

描述

checkpoint_id

String

还原点ID

created_at

String

创建时间，例如:"2020-02-05T10:38:34.209782"

description

String

备份描述

expired_at

String

过期时间，例如:"2020-02-05T10:38:34.209782"

extend_info

BackupExtendInfo object

扩展信息

id

String

备份ID

image_type

String

|-

name

String

备份名称

parent_id

String

父备份ID

project_id

String

项目ID

protected_at

String

备份时间

resource_az

String

资源可用区

resource_id

String

资源ID

resource_name

String

资源名称

resource_size

Integer

资源大小，单位为GB

resource_type

String

|-

status

String

备份状态

  • available: 可用

  • protecting: 保护中

  • deleting: 删除中

  • restoring: 恢复中

  • error: 异常

  • waiting_protect: 等待保护

  • waiting_delete: 等待删除

  • waiting_restore: 等待恢复

枚举值：

  • available

  • protecting

  • deleting

  • restoring

  • error

  • waiting_protect

  • waiting_delete

  • waiting_restore

updated_at

String

更新时间，例如:"2020-02-05T10:38:34.209782"

vault_id

String

存储库ID

enterprise_project_id

String

企业项目id,默认为‘0’。

children

Array of BackupResp objects

子副本列表

incremental

Boolean

是否是增备
表6 BackupExtendInfo

参数

参数类型

描述

auto_trigger

Boolean

是否是自动生成的备份副本

bootable

Boolean

是否系统盘备份

snapshot_id

String

卷备份副本的快照id

support_lld

Boolean

是否支持lazyloading快速恢复

supported_restore_mode

String

备份支持恢复的方式

  • na: 备份不支持直接恢复，只支持备份创建新资源等操作。

  • backup: 备份支持通过云服务器上硬盘的备份进行恢复。

  • snapshot: 备份此时已经支持创建整机镜像。

缺省值：na

枚举值：

  • na

  • backup

  • snapshot

os_images_data

Array of ImageData objects

备份注册镜像ID列表

contain_system_disk

Boolean

整机备份是否包含系统盘

encrypted

Boolean

是否加密

system_disk

Boolean

是否是系统盘
表7 ImageData

参数

参数类型

描述

image_id

String

镜像ID
表8 ReplicationRecordsExtraInfo

参数

参数类型

描述

progress

Integer

复制进度

fail_code

String

失败错误码，成功时为空

fail_reason

String

错误原因

auto_trigger

Boolean

是否为自动调度复制

destinatio_vault_id

String

目标端的存储库id

请求示例

查询所有备份副本。

GET https://{endpoint}/v3/{project_id}/backups

响应示例

状态码： 200

OK

{
  "count" : 2,
  "backups" : [ {
    "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
    "checkpoint_id" : "1fced58b-2a31-4851-bcbb-96216f83ce99",
    "updated_at" : "2020-02-21T07:07:25.114+00:00",
    "vault_id" : "cca85ea5-00a4-418d-9222-bd83985bc515",
    "id" : "b1c4afd9-e7a6-4888-9010-c2bac3aa7910",
    "resource_az" : "br-iaas-odin1a",
    "image_type" : "backup",
    "resource_id" : "1a503932-ee8f-4dd5-8248-8dfb57e584c5",
    "resource_size" : 40,
    "children" : [ ],
    "extend_info" : {
      "auto_trigger" : true,
      "supported_restore_mode" : "backup",
      "contain_system_disk" : true,
      "support_lld" : true,
      "system_disk" : false
    },
    "project_id" : "0605767b5780d5762fc5c0118072a564",
    "status" : "available",
    "resource_name" : "test001-02",
    "description" : "",
    "expired_at" : "2020-05-21T07:00:54.060+00:00",
    "name" : "autobk_b629",
    "created_at" : "2020-02-21T07:00:54.065+00:00",
    "resource_type" : "OS::Nova::Server"
  }, {
    "provider_id" : "d1603440-187d-4516-af25-121250c7cc97",
    "checkpoint_id" : "f64c351f-769f-4c04-8806-fd90a59e9b12",
    "updated_at" : "2020-02-21T07:09:37.767+00:00",
    "vault_id" : "79bd9daa-884f-4f84-b8fe-235d58cd927d",
    "id" : "5606aab5-2dc2-4498-8144-dc848d099af5",
    "resource_az" : "br-iaas-odin1a",
    "image_type" : "backup",
    "resource_id" : "54f7ccbc-072f-4ec5-a7b7-b24dabdb4539",
    "resource_size" : 40,
    "children" : [ ],
    "extend_info" : {
      "auto_trigger" : true,
      "snapshot_id" : "e3def9a8-e4b4-4c12-b132-f4ba8ce9a34f",
      "bootable" : true,
      "support_lld" : true,
      "encrypted" : false,
      "system_disk" : false
    },
    "project_id" : "0605767b5780d5762fc5c0118072a564",
    "status" : "available",
    "resource_name" : "qsy_000",
    "description" : "",
    "expired_at" : "2020-03-22T07:00:34.878+00:00",
    "name" : "autobk_6809",
    "created_at" : "2020-02-21T07:00:34.882+00:00",
    "resource_type" : "OS::Cinder::Volume"
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 备份