查询所有备份
URI
GET /v3/{project_id}/backups
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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,all_granted_eps表示查询用户有权限的所有企业项目id 获取方法请参见"获取企业项目ID"。 |
image_type |
否 |
String |
备份类型。backup:普通备份;replication:跨区域复制备份 |
incremental |
否 |
Boolean |
是否为增量备份 |
limit |
否 |
Integer |
返回结果个数限制,取值范围:[1-1000],默认值为1000。 |
marker |
否 |
String |
上一次查询最后一条的id |
member_status |
否 |
String |
共享状态,取值范围如下: |
name |
否 |
String |
备份名称,最大支持255字符,只能由中文、字母、数字、“_”、“-”组成。 |
offset |
否 |
Integer |
偏移值,默认为0。 |
own_type |
否 |
String |
持有类型,默认为private。 |
parent_id |
否 |
String |
父备份ID,格式为UUID。 获取方法请参见"获取备份ID"。 |
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] |
start_time |
否 |
String |
备份产生时间范围的开始时间,格式为%YYYY-%mm-%ddT%HH:%MM:%SSZ,例如2018-02-01T12:00:00Z |
status |
否 |
String |
备份状态。调用API时,支持通过传多个status值进行过滤。例如:status=available&status=error。具体取值范围如下: |
used_percent |
否 |
String |
根据存储库使用率过滤备份,取值范围 [1, 100],含1和100。例如,used_percent=80,表示筛选所属存储库使用率大于等于80%的所有备份。 |
vault_id |
否 |
String |
存储库ID。 获取方法请参见"获取存储库ID"。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
backups |
Array of BackupResp objects |
备份列表 |
count |
Integer |
备份个数 |
offset |
Integer |
偏移量,表示从此偏移量开始查询 |
limit |
Integer |
每页显示的条目数量 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
备份名称,最大支持255字符,只能由数字、中文、英文大小写字母,以及下划线"_"和中横线 "-" 字符构成。 |
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:云桌面 |
status |
String |
备份状态 |
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’。 获取方法请参见"获取企业项目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 |
是否是增备 |
version |
Integer |
备份副本快照类型 |
参数 |
参数类型 |
描述 |
---|---|---|
auto_trigger |
Boolean |
是否是自动生成的备份副本。 |
bootable |
Boolean |
是否系统盘备份。 - true:系统盘备份 - false:非系统盘备份 |
snapshot_id |
String |
卷备份副本的快照id |
support_lld |
Boolean |
是否支持lazyloading快速恢复。 - true:支持lazyloading快速恢复 - false:不支持lazyloading快速恢复 |
supported_restore_mode |
String |
备份支持恢复的方式 |
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备份,默认为false 取值范围: |
参数 |
参数类型 |
描述 |
---|---|---|
created_at |
String |
复制的开始时间 |
destination_backup_id |
String |
复制的目标区域备份ID 获取方法请参见"获取备份ID"。其中project_id需填写目标区域的project_id。 |
destination_checkpoint_id |
String |
复制的目的备份记录ID |
destination_project_id |
String |
复制时目标区域项目ID。 获取方法请参见"获取项目ID"。其中project_id需填写目标区域的project_id。 |
destination_region |
String |
复制的目标区域。获取方法请参见"地区和终端节点查询"。 |
destination_vault_id |
String |
目标存储库ID。获取方法请参见"获取存储库ID"。其中project_id需填写目标区域的project_id。 |
extra_info |
ReplicationRecordsExtraInfo object |
复制附加信息 |
id |
String |
复制记录ID |
source_backup_id |
String |
复制时源端项目ID。 获取方法请参见"获取项目ID"。其中project_id需填写源端的project_id。 |
source_checkpoint_id |
String |
复制的源备份记录ID |
source_project_id |
String |
复制时源端区域的项目ID。 获取方法请参见"获取项目ID"。 |
source_region |
String |
复制的源区域。 获取方法请参见"地区和终端节点查询"。 |
status |
String |
复制的状态 |
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 |
错误码
请参见错误码。