查询存储库列表
功能介绍
查询存储库列表
URI
GET /v3/{project_id}/vaults
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
cloud_type |
否 |
String |
公有云: public |
|
enterprise_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）。 |
|
offset |
否 |
Integer |
偏移值,正整数 |
|
policy_id |
否 |
String |
策略ID |
|
protect_type |
否 |
String |
保护类型：备份（backup）。 |
|
resource_ids |
否 |
String |
资源id |
|
status |
否 |
String |
状态 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
vaults |
Array of Vault objects |
存储库实例列表 |
|
count |
Integer |
存储库个数 |
|
limit |
Integer |
每页显示的条目数量 最小值：1 最大值：1000 缺省值：1000 |
|
offset |
Integer |
偏移量，表示从此偏移量开始查询 最小值：0 缺省值：0 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
billing |
Billing object |
运营信息 |
|
description |
String |
存储库自定义描述信息。 最小长度：0 最大长度：255 |
|
id |
String |
存储库ID |
|
name |
String |
存储库名称 最小长度：1 最大长度：64 |
|
project_id |
String |
项目ID |
|
provider_id |
String |
存储库资源类型id |
|
resources |
Array of ResourceResp objects |
存储库资源 |
|
tags |
Array of Tag objects |
存储库标签 |
|
enterprise_project_id |
String |
企业项目id，默认为‘0’。 |
|
auto_bind |
Boolean |
是否自动绑定，默认为false，不支持。 |
|
bind_rules |
VaultBindRules object |
绑定规则 |
|
user_id |
String |
用户id |
|
created_at |
String |
创建时间,例如:"2020-02-05T10:38:34.209782" |
|
auto_expand |
Boolean |
是否开启存储库自动扩容能力。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
allocated |
Integer |
已分配容量，单位GB |
|
charging_mode |
String |
创建模式，按需：post_paid |
|
cloud_type |
String |
公有云: public |
|
consistent_level |
String |
规格，崩溃一致性（crash_consistent）或应用一致性（app_consistent） |
|
object_type |
String |
对象类型：云服务器（server），云硬盘（disk），文件系统（turbo）。 |
|
order_id |
String |
订单ID |
|
product_id |
String |
产品ID |
|
protect_type |
String |
保护类型：备份（backup）。 |
|
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 |
冻结场景 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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::Sfs::Turbo |
|
backup_size |
Integer |
副本大小 |
|
backup_count |
Integer |
副本数量 |
请求示例
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 |
错误码
请参见错误码。
