查询所有备份 - ListBackups

project_id

是

String

参数解释：

项目ID，获取方法请参见获取项目ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

checkpoint_id

否

String

参数解释：

还原点ID，用于唯一标识一个备份还原点

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

dec

否

Boolean

参数解释：

是否为专属云场景

约束限制：

不涉及

取值范围：

• true：专属云场景

• false：非专属云场景

默认取值：

不涉及

end_time

否

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

enterprise_project_id

否

String

参数解释：

企业项目ID或all_granted_eps，获取方法请参见获取企业项目ID，all_granted_eps表示查询用户有权限的所有企业项目ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

image_type

否

String

参数解释：

备份类型

约束限制：

不涉及

取值范围：

backup：普通备份；replication：跨区域复制备份

默认取值：

不涉及

incremental

否

Boolean

参数解释：

是否为增量备份

约束限制：

不涉及

取值范围：

• true：增量备份

• false：全量备份

默认取值：

不涉及

limit

否

Integer

参数解释：

返回结果个数限制

约束限制：

可与offset配合使用进行分页查询

取值范围：

[1-1000]

默认取值：

1000

marker

否

String

参数解释：

上一次查询最后一条的ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

member_status

否

String

参数解释：

共享状态

约束限制：

不涉及

取值范围：

• pending：待接受，表示共享邀请已发出，目标项目（或用户）尚未同意或拒绝该备份共享请求。

• accepted：已接收，表示目标项目（或用户）已同意接受该备份共享，并可在自己的存储库中使用该备份。

• rejected：已拒绝，表示目标项目（或用户）已拒绝接受该备份共享。

默认取值：

不涉及

name

否

String

参数解释：

备份名称

约束限制：

不涉及

取值范围：

最大支持255字符，只能由中文、字母、数字、“_”、“-”组成

默认取值：

不涉及

offset

否

Integer

参数解释：

偏移值，用于分页查询时指定查询的起始位置，表示从第几条记录开始查询

约束限制：

与limit配合使用进行分页查询

取值范围：

[0,2147483647]

默认取值：

不涉及

own_type

否

String

参数解释：

持有类型

约束限制：

不涉及

取值范围：

• private：私有备份，即仅查询当前项目下自己持有的备份。

• shared：共享备份，即查询被其他项目共享给当前项目的备份。

• all_granted：全部备份，即同时查询私有和共享的所有备份。

默认取值：

private

parent_id

否

String

参数解释：

父备份ID，获取方法请参见获取备份ID

约束限制：

不涉及

取值范围：

格式为UUID

默认取值：

不涉及

resource_az

否

String

参数解释：

备份资源所在的区域ID信息。

获取方法请参见"地区和终端节点查询"。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

resource_id

否

String

参数解释：

资源ID

约束限制：

不涉及

取值范围：

格式为UUID

默认取值：

不涉及

resource_name

否

String

参数解释：

资源名称

约束限制：

不涉及

取值范围：

最大支持255字符

默认取值：

不涉及

resource_type

否

String

参数解释：

待备份资源的类型

约束限制：

不涉及

取值范围：

OS::Nova::Server：云服务器； OS::Cinder::Volume：云硬盘；OS::Ironic::BareMetalServer：裸金属服务器；OS::Sfs::Turbo：SFS Turbo文件系统；OS::Workspace::DesktopV2：云桌面

默认取值：

不涉及

show_replication

否

Boolean

参数解释：

是否返回复制记录

约束限制：

不涉及

取值范围：

• true：返回复制记录

• false：不返回复制记录

默认取值：

不涉及

sort

否

String

参数解释：

sort的内容为一组由逗号分隔的属性及可选排序方向组成，形如<key1>[:<direction>],<key2>[:<direction>],其中direction的取值为asc (升序) 或 desc (降序),如没有传入direction参数

约束限制：

sort内容的长度限制为255个字符

取值范围：

key取值范围:[created_at，updated_at，name，status，protected_at，id]

默认取值：

desc (降序)

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

参数解释：

根据存储库使用率过滤备份，例如，used_percent=80，表示筛选所属存储库使用率大于等于80%的所有备份

约束限制：

不涉及

取值范围：

[1, 100]

默认取值：

不涉及

vault_id

否

String

参数解释：

存储库ID，获取方法请参见获取存储库ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

existed_quantity_based_retention_backups

否

Boolean

参数解释：

是否查询按数量保留或永久保留自动备份

约束限制：

不涉及

取值范围：

• true：返回按数量保留或永久保留自动备份

• false：返回按时间保留自动备份

默认取值：

不涉及

X-Auth-Token

是

String

参数解释：

用户Token。

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

backups

Array of BackupResp objects

参数解释：

查询返回的备份信息列表，包含符合条件的所有备份详情

取值范围：

不涉及

count

Integer

参数解释：

备份个数

取值范围：

不涉及

offset

Integer

参数解释：

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

取值范围：

[0,2147483647]

limit

Integer

参数解释：

每页显示的条目数量

取值范围：

[1-1000]

checkpoint_id

String

参数解释：

还原点ID

取值范围：

不涉及

created_at

String

参数解释：

创建时间，使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSSSS，例如:"2020-02-05T10:38:34.209782"

取值范围：

不涉及

description

String

参数解释：

备份描述

取值范围：

不涉及

expired_at

String

参数解释：

过期时间，使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSSSS，例如:"2020-02-05T10:38:34.209782"

取值范围：

不涉及

extend_info

BackupExtendInfo object

参数解释：

扩展信息

id

String

参数解释：

备份ID

取值范围：

不涉及

image_type

String

参数解释：

备份类型

取值范围：

backup：普通备份；replication：跨区域复制备份。

name

String

参数解释：

备份名称。

取值范围：

只能由数字、中文、英文大小写字母、下划线"_"和中横线"-"组成，最大支持64个字符。

parent_id

String

参数解释：

父备份ID

取值范围：

不涉及

project_id

String

参数解释：

项目ID

取值范围：

不涉及

protected_at

String

参数解释：

备份时间

取值范围：

不涉及

resource_az

String

参数解释：

资源可用区

取值范围：

不涉及

resource_id

String

参数解释：

资源ID，格式为UUID，可根据待备份的资源类型查询对应的资源情况

取值范围：

不涉及

resource_name

String

参数解释：

待备份资源名称

取值范围：

0-255字符

resource_size

Integer

参数解释：

资源大小，单位为GB

取值范围：

不涉及

resource_type

String

参数解释：

待备份资源的类型

取值范围：

OS::Nova::Server：云服务器； OS::Cinder::Volume：云硬盘；OS::Ironic::BareMetalServer：裸金属服务器；OS::Sfs::Turbo：SFS Turbo文件系统；OS::Workspace::DesktopV2：云桌面。

scheduled_operation_id

String

参数解释：

策略ID

取值范围：

不涉及

status

String

参数解释：

备份状态

取值范围：

• available: 可用

• protecting: 保护中

• deleting: 删除中

• restoring: 恢复中

• error: 异常

• waiting_protect: 等待保护

• waiting_delete: 等待删除

• waiting_restore: 等待恢复

updated_at

String

参数解释：

更新时间，使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSSSS，例如:"2020-02-05T10:38:34.209782

取值范围：

不涉及

vault_id

String

参数解释：

存储库ID

取值范围：

不涉及

replication_records

Array of ReplicationRecordGet objects

参数解释：

复制记录

enterprise_project_id

String

参数解释：

企业项目ID

取值范围：

不涉及

provider_id

String

参数解释：

备份提供商ID，用于区分备份对象

取值范围：

0daac4c5-6707-4851-97ba-169e36266b66，该值代表备份对象为云服务器。d1603440-187d-4516-af25-121250c7cc97，该值代表备份对象为云硬盘。3f3c3220-245c-4805-b811-758870015881， 该值代表备份对象为SFS Turbo。a13639de-00be-4e94-af30-26912d75e4a2，该值代表备份对象为混合云VMware备份。

children

Array of BackupResp objects

参数解释：

子副本列表

incremental

Boolean

参数解释：

是否是增备

取值范围：

• true：增量备份

• false：全量备份

version

Integer

参数解释：

备份副本快照类型

取值范围：

不涉及

auto_trigger

Boolean

参数解释：

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

取值范围：

• true：自动生成的备份副本

• false：非自动生成的备份副本

bootable

Boolean

参数解释：

是否系统盘备份

取值范围：

• true：系统盘备份。

• false：非系统盘备份。

snapshot_id

String

参数解释：

卷备份副本的快照ID

取值范围：

不涉及

support_lld

Boolean

参数解释：

是否支持lazyloading快速恢复

取值范围：

• true：支持lazyloading快速恢复。

• false：不支持lazyloading快速恢复。

supported_restore_mode

String

参数解释：

备份支持恢复的方式

取值范围：

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

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

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

os_images_data

Array of ImageData objects

参数解释：

备份注册镜像ID列表

contain_system_disk

Boolean

参数解释：

整机备份是否包含系统盘

取值范围：

• true：整机备份包含系统盘

• false：整机备份不包含系统盘

encrypted

Boolean

参数解释：

是否加密备份

取值范围：

• true：加密备份

• false：非加密备份

system_disk

Boolean

参数解释：

是否是系统盘

取值范围：

• true：系统盘

• false：非系统盘

is_multi_az

Boolean

参数解释：

存储库是否具有多AZ属性，即底层备份是否为多AZ备份

取值范围：

• true：存储库具有多AZ属性

• false：存储库不具有多AZ属性

image_id

String

参数解释：

镜像ID

取值范围：

不涉及

created_at

String

参数解释：

复制的开始时间，使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSSSS，例如:"2020-02-05T10:38:34.209782"

取值范围：

不涉及

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

ReplicationRecordsExtraInfo object

参数解释：

复制附加信息

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

取值范围：

不涉及

progress

Integer

参数解释：

复制进度

取值范围：

[1,100]

fail_code

String

参数解释：

失败错误码，成功时为空

取值范围：

不涉及

fail_reason

String

参数解释：

错误原因

取值范围：

不涉及

auto_trigger

Boolean

参数解释：

是否自动触发

取值范围：

• true：自动触发

• false：非自动触发

destination_vault_id

String

参数解释：

目标端的存储库ID

取值范围：

不涉及

200

OK