文档首页 > > API参考> API> 备份> 查询所有备份

查询所有备份

分享
更新时间:2020/10/23 GMT+08:00

功能介绍

查询所有副本

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

备份类型

枚举值:

  • backup

  • replication

limit

Integer

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

marker

String

上一次查询最后一条的id

member_status

String

共享状态

枚举值:

  • pending

  • accept

  • reject

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

资源类型

枚举值:

  • OS::Cinder::Volume

  • OS::Nova::Server

sort

String

sort的内容为一组由逗号分隔的属性及可选排序方向组成,形如[:],[:],其中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

备份个数

表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

备份类型

枚举值:

  • backup

  • replication

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

资源类型

枚举值:

  • OS::Nova::Server

  • OS::Cinder::Volume

status

String

备份状态

枚举值:

  • available

  • protecting

  • deleting

  • restoring

  • error

  • waiting_protect

  • waiting_delete

  • waiting_restore

updated_at

String

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

vault_id

String

存储库ID

replication_records

Array of ReplicationRecordGet objects

复制记录

enterprise_project_id

String

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

表6 BackupExtendInfo

参数

参数类型

描述

auto_trigger

Boolean

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

bootable

Boolean

是否系统盘备份

incremental

Boolean

是否是增备

snapshot_id

String

卷备份副本的快照id

support_lld

Boolean

是否支持lazyloading快速恢复

supported_restore_mode

String

备份支持恢复的方式,当前取值包含na,snapshot和backup。如果该字段取值为snapshot,代表备份此时已经支持创建整机镜像;如果该字段取值为backup,备份支持通过云服务器上硬盘的备份进行恢复;如果该字段取值为na,备份不支持恢复。

缺省值:na

枚举值:

  • na

  • backup

  • snapshot

os_images_data

Array of strings

备份注册镜像ID列表

contain_system_disk

Boolean

整机备份是否包含系统盘

encrypted

Boolean

是否加密

system_disk

Boolean

是否是系统盘

表7 ReplicationRecordGet

参数

参数类型

描述

created_at

String

复制的开始时间

destination_backup_id

String

复制的目的备份ID

destination_checkpoint_id

String

复制的目的备份记录ID

destination_project_id

String

复制的目标项目ID

destination_region

String

复制的目标区域

destination_vault_id

String

目标存储库ID

extra_info

String

复制附加信息

id

String

复制记录ID

source_backup_id

String

复制的源备份ID

source_checkpoint_id

String

复制的源备份记录ID

source_project_id

String

复制的源项目ID

source_region

String

复制的源区域

status

String

复制的状态

枚举值:

  • replicating

  • success

  • fail

  • skip

  • waiting_replicate

vault_id

String

备份所在的存储库ID

请求示例

响应示例

状态码为 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.113761",
    "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,
      "architecture" : "x86_64",
      "system_disk" : false,
      "app_consistency" : {
        "app_consistency_error_code" : "0",
        "app_consistency_status" : "0",
        "app_consistency_error_message" : "",
        "app_consistency" : "0"
      }
    },
    "project_id" : "0605767b5780d5762fc5c0118072a564",
    "status" : "available",
    "resource_name" : "test001-02",
    "description" : "",
    "expired_at" : "2020-05-21T07:00:54.060493",
    "replication_records" : [ ],
    "name" : "autobk_b629",
    "created_at" : "2020-02-21T07:00:54.065135",
    "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.767084",
    "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,
      "progress" : 100,
      "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.877896",
    "replication_records" : [ ],
    "name" : "autobk_6809",
    "created_at" : "2020-02-21T07:00:34.882174",
    "resource_type" : "OS::Cinder::Volume"
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问