查询存储库列表
功能介绍
查询存储库列表
URI
GET /v3/{project_id}/vaults
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID,默认取值不涉及。 获取方法请参见"获取项目ID" |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
cloud_type |
否 |
String |
云类型,默认为public,支持类型如下。 public:公有云; hybrid: 混合云 |
|
enterprise_project_id |
否 |
String |
企业项目ID或all_granted_eps,all_granted_eps表示查询用户有权限的所有企业项目id,默认取值不涉及。 获取方法请参见"获取企业项目ID"。 |
|
id |
否 |
String |
存储库ID,默认取值不涉及。 |
|
limit |
否 |
Integer |
返回结果个数限制,取值范围:[1-1000],默认值为1000。 |
|
name |
否 |
String |
存储库名称,最大支持64字符,只能由中文、字母、数字、“_”、“-”组成,默认取值不涉及。 |
|
object_type |
否 |
String |
对象类型,支持"server", "disk", "turbo", "workspace", "vmware", "rds"和"file"共七种。server:云服务器,disk:云硬盘,turbo:文件系统,workspace:云桌面,vmware:VMware,rds:关系型数据库,file:文件。默认取值不涉及。 |
|
offset |
否 |
Integer |
偏移值,默认为0。 |
|
policy_id |
否 |
String |
策略ID,默认取值不涉及。 获取方法请参见"获取备份策略ID"。 |
|
protect_type |
否 |
String |
保护类型,默认取值不涉及。取值范围如下: backup:备份,replication:复制 |
|
resource_ids |
否 |
String |
资源ID列表,支持多资源,多个资源ID间以英文逗号分隔,资源ID格式为UUID。默认取值不涉及。 |
|
status |
否 |
String |
存储库状态,默认取值不涉及。取值范围如下: |
|
availability_zone |
否 |
String |
存储库可用区信息,默认取值不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。默认取值不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
vaults |
Array of Vault objects |
存储库实例列表 |
|
count |
Integer |
存储库个数,取值范围不涉及。 |
|
limit |
Integer |
每页显示的条目数量,取值范围:[1-1000]。 |
|
offset |
Integer |
偏移量,表示从此偏移量开始查询,取值范围大于0。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
billing |
Billing object |
运营信息 |
|
description |
String |
存储库自定义描述信息,不能包含“<”,“>”,最大支持255个字符。 |
|
id |
String |
存储库ID,取值范围不涉及。 |
|
name |
String |
存储库名称,最大支持64字符,只能由中文、字母、数字、“_”、“-”组成。 |
|
project_id |
String |
项目ID。 获取方法请参见"获取项目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备份。 |
|
resources |
Array of ResourceResp objects |
存储库资源 |
|
tags |
Array of Tag objects |
存储库标签 |
|
enterprise_project_id |
String |
企业项目ID。 获取方法请参见"获取企业项目ID"。 |
|
auto_bind |
Boolean |
功能说明:是否支持自动挂载。 取值范围: |
|
bind_rules |
VaultBindRules object |
绑定规则 |
|
user_id |
String |
用户id |
|
created_at |
String |
创建时间,例如:"2020-02-05T10:38:34.209782" |
|
auto_expand |
Boolean |
功能说明:是否开启存储库自动扩容能力(只支持按需存储库),取值范围:true:支持自动扩容;false:不支持自动扩容。 |
|
smn_notify |
Boolean |
功能说明:是否发送smn通知开关。 取值范围: |
|
threshold |
Integer |
功能说明:存储库容量阈值,存储库已用容量和总容量的百分比超过该值,如果smn_notify为开,将发送相关通知。 取值范围:[1, 100]。 |
|
sys_lock_source_service |
String |
用于标识SMB服务,支持传入SMB和空。 SMB:标识为SMB服务调用 空字符串:表示为普通服务调用 |
|
locked |
Boolean |
功能说明:用于标识当前存储库是否已锁定,锁定的存储库不支持解锁。 关于备份锁定的详细信息,请参考"开启备份锁定"。 取值范围: |
|
availability_zone |
String |
存储库可用区信息,最大支持32字符。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
allocated |
Integer |
已分配容量,单位GB。取值范围:10-10485760。 |
|
charging_mode |
String |
功能说明:计费模式。取值范围:post_paid:按需,pre_paid:包年包月 |
|
cloud_type |
String |
云类型,支持类型如下。 public:公有云; hybrid: 混合云 |
|
consistent_level |
String |
功能描述:存储库规格。取值范围:app_consistent: 应用一致性,crash_consistent: 崩溃一致性。 |
|
object_type |
String |
对象类型,支持"server", "disk", "turbo", "workspace", "vmware", "rds"和"file"共七种。server:云服务器,disk:云硬盘,turbo:文件系统,workspace:云桌面,vmware:VMware,rds:关系型数据库,file:文件。 |
|
order_id |
String |
订单ID,UUID格式。 |
|
product_id |
String |
产品ID,UUID格式。 |
|
protect_type |
String |
保护类型,取值范围如下: backup:备份,replication:复制 |
|
size |
Integer |
容量,单位GB。取值范围:10-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 |
冻结场景,取值范围如下: |
|
is_multi_az |
Boolean |
功能说明:存储库是否具有多AZ属性,即底层备份是否为多AZ备份。 取值范围: |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
extra_info |
ResourceExtraInfo object |
资源附加信息 |
|
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:SFS Turbo文件系统;OS::Workspace::DesktopV2:云桌面。 |
|
backup_size |
Integer |
备份副本大小。单位GB。取值范围不涉及。 |
|
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",
"resources" : [ ],
"provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
"created_at" : "2020-09-04T06:57:37.344+00:00",
"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",
"charging_mode" : "post_paid",
"protect_type" : "backup",
"object_type" : "server",
"spec_code" : "vault.backup.server.normal",
"used" : 0,
"status" : "available",
"size" : 100
},
"tags" : [ ],
"availability_zone" : "cn-southwest-242"
} ],
"count" : 50
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。