功能介绍
查询存储库列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v3/{project_id}/vaults
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
cloud_type |
否 |
String |
公有云:public ;混合云:hybrid |
ent erp rise_project_id |
否 |
String |
企业项目id或all_granted_eps,all_granted_eps表示查询用户有权限的所有企业项目id |
id |
否 |
String |
存储库ID |
limit |
否 |
Integer |
每页显示条目数,正整数 最小值:1 最大值:1000 |
name |
否 |
String |
存储库名称 |
object_type |
否 |
String |
对象类型: 云服务器 (server), 云硬盘 (disk),文件系统(turbo), 云桌面 (workspace),VMware(vmware),关系型 数据库 (rds),文件(file)。 |
offset |
否 |
Integer |
偏移值,正整数 |
policy_id |
否 |
String |
策略ID |
protect_type |
否 |
String |
保护类型:备份(backup)、复制(replication)。 |
resource_ids |
否 |
String |
资源id,支持多资源,以英文逗号分割 |
status |
否 |
String |
状态 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
vaults |
存储库实例列表 |
|
count |
Integer |
存储库个数 |
limit |
Integer |
每页显示的条目数量 最小值:1 最大值:1000 缺省值:1000 |
offset |
Integer |
偏移量,表示从此偏移量开始查询 最小值:0 缺省值:0 |
参数 |
参数类型 |
描述 |
---|---|---|
billing |
运营信息 |
|
description |
String |
存储库自定义描述信息。 最小长度:0 最大长度:255 |
id |
String |
存储库ID |
name |
String |
存储库名称 最小长度:1 最大长度:64 |
project_id |
String |
项目ID |
provider_id |
String |
存储库资源类型id |
resources |
存储库资源 |
|
tags |
存储库标签 |
|
enterprise_project_id |
String |
企业项目id,默认为‘0’。 |
auto_bind |
Boolean |
是否自动绑定,默认为false,不支持。 |
bind_rules |
绑定规则 |
|
user_id |
String |
用户id |
created_at |
String |
创建时间,例如:"2020-02-05T10:38:34.209782" |
auto_expand |
Boolean |
是否开启存储库自动扩容能力(只支持按需存储库)。 |
smn_notify |
Boolean |
存储库smn 消息通知 开关 缺省值:true |
threshold |
Integer |
存储库容量阈值,已用容量占总容量达到此百分比即发送相关通知 最小值:1 最大值:100 缺省值:80 |
参数 |
参数类型 |
描述 |
---|---|---|
allocated |
Integer |
已分配容量,单位GB |
charging_mode |
String |
创建模式,按需:post_paid,包周期:pre_paid,默认为post_paid |
cloud_type |
String |
公有云:public ;混合云:hybrid |
consistent_level |
String |
规格,崩溃一致性(crash_consistent)或应用一致性(app_consistent) |
object_type |
String |
对象类型: 云服务 器(server),云硬盘(disk),文件系统(turbo),云桌面(workspace),VMware(vmware),关系型数据库(rds),文件(file)。 |
order_id |
String |
订单ID |
product_id |
String |
产品ID |
protect_type |
String |
保护类型:备份(backup)、复制(replication)。 |
size |
Integer |
容量,单位GB 最小值:1 最大值:10485760 |
spec_code |
String |
规格编码。 云服务备份存储库:vault.backup.server.normal; 云硬盘备份 存储库:vault.backup.volume.normal;文件备份存储库:vault.backup.turbo.normal |
status |
String |
存储库状态 枚举值:
|
storage_unit |
String |
存储库桶名 |
used |
Integer |
已使用容量,单位MB |
frozen_scene |
String |
冻结场景 |
参数 |
参数类型 |
描述 |
---|---|---|
extra_info |
资源附加信息 |
|
id |
String |
待备份资源id |
name |
String |
待备份资源名称 最小长度:0 最大长度:255 |
protect_status |
String |
保护状态 枚举值:
|
size |
Integer |
资源已分配容量,单位为GB |
type |
String |
待备份资源的类型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, OS:: Workspace ::DesktopV2 |
backup_size |
Integer |
副本大小 |
backup_count |
Integer |
副本数量 |
参数 |
参数类型 |
描述 |
---|---|---|
exclude_volumes |
Array of strings |
需要排除备份的卷id。仅在多盘备份特性中有效,排除不需要备份的磁盘。当虚拟机新绑定磁盘时,也能继续排除之前设置不用备份的卷。 |
参数 |
参数类型 |
描述 |
---|---|---|
key |
String |
键。 key最大长度为36个字符。 key不能为空字符串。 key前后空格会被丢弃。 key不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。 key只能由中文,字母,数字,“-”,“_”组成。 |
value |
String |
值。 添加标签时value值必选,删除标签时value值可选。 value最大长度为43个字符。 value可以为空字符串。 value前后的空格会被丢弃。 value不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。 value只能由中文,字母,数字,“-”,“_”,“.”组成。 |
请求示例
查询存储库列表。
GET https://{endpoint}/v3/{project_id}/vaults
响应示例
状态码: 200
OK
{ "vaults" : [ { "id" : "a335f9e1-1628-4c64-a7be-38656e5ec19c", "name" : "vault-8538", "description" : null, "resources" : [ ], "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66", "created_at" : "2020-09-04T06:57:37.343535", "project_id" : "0605767b5780d5762fc5c0118072a564", "enterprise_project_id" : "0", "auto_bind" : false, "bind_rules" : { }, "auto_expand" : false, "user_id" : "aa2999fa5ae640f28926f8fd79188934", "billing" : { "allocated" : 0, "cloud_type" : "public", "consistent_level" : "crash_consistent", "frozen_scene" : null, "charging_mode" : "post_paid", "order_id" : null, "product_id" : null, "protect_type" : "backup", "object_type" : "server", "spec_code" : "vault.backup.server.normal", "used" : 0, "storage_unit" : null, "status" : "available", "size" : 100 }, "tags" : [ ] } ], "count" : 50 }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。