文档首页/ 云备份 CBR/ API参考/ API/ 存储库/ 查询指定存储库
更新时间:2025-07-12 GMT+08:00
分享

查询指定存储库

功能介绍

根据ID查询指定存储库

URI

GET /v3/{project_id}/vaults/{vault_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

获取方法请参见"获取项目ID"。

vault_id

String

存储库ID。

获取方法请参见"获取存储库ID"。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

vault

Vault object

存储库查询返回对象

表4 Vault

参数

参数类型

描述

billing

Billing object

运营信息

description

String

存储库自定义描述信息。

id

String

存储库ID

name

String

存储库名称,最大支持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’。

获取方法请参见"获取企业项目ID"。

auto_bind

Boolean

功能说明:是否支持自动挂载。默认为false。

取值范围:

  • true:支持自动挂载

  • false:不支持自动挂载

bind_rules

VaultBindRules object

绑定规则

user_id

String

用户id

created_at

String

创建时间,例如:"2020-02-05T10:38:34.209782"

auto_expand

Boolean

功能说明:是否开启存储库自动扩容能力(只支持按需存储库),默认为false。取值范围:true:支持自动扩容;false:不支持自动扩容。

smn_notify

Boolean

功能说明:是否发送smn通知开关,默认为true

取值范围:

  • true:发送smn通知

  • false:不发送smn通知

threshold

Integer

存储库容量阈值,已用容量占总容量达到此百分比即发送相关通知

sys_lock_source_service

String

用于标识SMB服务,支持传入SMB和空,默认值为空

SMB:标识为SMB服务调用

空字符串:表示为普通服务调用

locked

Boolean

功能说明:用于标识当前存储库是否已锁定,锁定的存储库不支持解锁。

关于备份锁定的详细信息,请参考"开启备份锁定"。

取值范围:

  • true:锁定存储库

  • false:不锁定存储库

表5 Billing

参数

参数类型

描述

allocated

Integer

已分配容量,单位GB

charging_mode

String

功能说明:计费模式。默认值为post_paid。取值范围:post_paid:按需,pre_paid:包年包月

cloud_type

String

云类型,默认为public,支持类型如下。

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

product_id

String

产品ID

protect_type

String

保护类型,取值范围如下:

backup:备份,replication:复制

size

Integer

容量,单位GB

spec_code

String

规格编码。

云服务备份存储库:vault.backup.server.normal;云硬盘备份存储库:vault.backup.volume.normal;文件备份存储库:vault.backup.turbo.normal

status

String

存储库状态

  • available: 可用

  • lock: 锁定

  • frozen: 冻结

  • deleting: 删除中

  • error: 异常

storage_unit

String

存储库桶名

used

Integer

已使用容量,单位MB

frozen_scene

String

冻结场景

is_multi_az

Boolean

功能说明:存储库是否具有多AZ属性,即底层备份是否为多AZ备份,默认为false

取值范围:

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

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

表6 ResourceResp

参数

参数类型

描述

extra_info

ResourceExtraInfo object

资源附加信息

id

String

待备份资源id,需要该资源已经绑定到该存储库中,且属于可备份的状态。

获取方法请参见"查询存储库绑定资源信息","查询资源可保护性"。

name

String

待备份资源名称,长度限制:0-255字符

protect_status

String

保护状态

  • available: 可用

  • error: 异常

  • protecting: 保护中

  • restoring: 恢复中

  • removing: 删除中

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

副本数量

表7 ResourceExtraInfo

参数

参数类型

描述

exclude_volumes

Array of strings

需要排除备份的卷id。仅在多盘备份特性中有效,排除不需要备份的磁盘。当虚拟机新绑定磁盘时,也能继续排除之前设置不用备份的卷。

表8 Tag

参数

参数类型

描述

key

String

键。

key最大长度为36个字符。

key不能为空字符串。

key前后空格会被丢弃。

key不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

key只能由中文,字母,数字,“-”,“_”组成。

value

String

值。

添加标签时value值必选,删除标签时value值可选。

value最大长度为43个字符。

value可以为空字符串。

value前后的空格会被丢弃。

value不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

value只能由中文,字母,数字,“-”,“_”,“.”组成。

表9 VaultBindRules

参数

参数类型

描述

tags

Array of BindRulesTags objects

按tags过滤自动绑定的资源

最小长度:0

最大长度:5

表10 BindRulesTags

参数

参数类型

描述

key

String

key不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

key只能由中文,字母,数字,“-”,“_”组成。

value

String

value不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

value只能由中文,字母,数字,“-”,“_”,“.”组成。

状态码:404

表11 响应Body参数

参数

参数类型

描述

vault

Vault object

存储库查询返回对象

表12 Vault

参数

参数类型

描述

billing

Billing object

运营信息

description

String

存储库自定义描述信息。

id

String

存储库ID

name

String

存储库名称,最大支持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’。

获取方法请参见"获取企业项目ID"。

auto_bind

Boolean

功能说明:是否支持自动挂载。默认为false。

取值范围:

  • true:支持自动挂载

  • false:不支持自动挂载

bind_rules

VaultBindRules object

绑定规则

user_id

String

用户id

created_at

String

创建时间,例如:"2020-02-05T10:38:34.209782"

auto_expand

Boolean

功能说明:是否开启存储库自动扩容能力(只支持按需存储库),默认为false。取值范围:true:支持自动扩容;false:不支持自动扩容。

smn_notify

Boolean

功能说明:是否发送smn通知开关,默认为true

取值范围:

  • true:发送smn通知

  • false:不发送smn通知

threshold

Integer

存储库容量阈值,已用容量占总容量达到此百分比即发送相关通知

sys_lock_source_service

String

用于标识SMB服务,支持传入SMB和空,默认值为空

SMB:标识为SMB服务调用

空字符串:表示为普通服务调用

locked

Boolean

功能说明:用于标识当前存储库是否已锁定,锁定的存储库不支持解锁。

关于备份锁定的详细信息,请参考"开启备份锁定"。取值范围:

  • true:锁定存储库

  • false:不锁定存储库

表13 Billing

参数

参数类型

描述

allocated

Integer

已分配容量,单位GB

charging_mode

String

功能说明:计费模式。默认值为post_paid。取值范围:post_paid:按需,pre_paid:包年包月

cloud_type

String

云类型,默认为public,支持类型如下。

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

product_id

String

产品ID

protect_type

String

保护类型,取值范围如下:

backup:备份,replication:复制

size

Integer

容量,单位GB

spec_code

String

规格编码。

云服务备份存储库:vault.backup.server.normal;云硬盘备份存储库:vault.backup.volume.normal;文件备份存储库:vault.backup.turbo.normal

status

String

存储库状态

  • available: 可用

  • lock: 锁定

  • frozen: 冻结

  • deleting: 删除中

  • error: 异常

storage_unit

String

存储库桶名

used

Integer

已使用容量,单位MB

frozen_scene

String

冻结场景

is_multi_az

Boolean

功能说明:存储库是否具有多AZ属性,即底层备份是否为多AZ备份,默认为false

取值范围:

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

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

表14 ResourceResp

参数

参数类型

描述

extra_info

ResourceExtraInfo object

资源附加信息

id

String

待备份资源id,需要该资源已经绑定到该存储库中,且属于可备份的状态。

获取方法请参见"查询存储库绑定资源信息","查询资源可保护性"。

name

String

待备份资源名称,长度限制:0-255字符

protect_status

String

保护状态

  • available: 可用

  • error: 异常

  • protecting: 保护中

  • restoring: 恢复中

  • removing: 删除中

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

副本数量

表15 ResourceExtraInfo

参数

参数类型

描述

exclude_volumes

Array of strings

需要排除备份的卷id。仅在多盘备份特性中有效,排除不需要备份的磁盘。当虚拟机新绑定磁盘时,也能继续排除之前设置不用备份的卷。

表16 Tag

参数

参数类型

描述

key

String

键。

key最大长度为36个字符。

key不能为空字符串。

key前后空格会被丢弃。

key不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

key只能由中文,字母,数字,“-”,“_”组成。

value

String

值。

添加标签时value值必选,删除标签时value值可选。

value最大长度为43个字符。

value可以为空字符串。

value前后的空格会被丢弃。

value不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

value只能由中文,字母,数字,“-”,“_”,“.”组成。

表17 VaultBindRules

参数

参数类型

描述

tags

Array of BindRulesTags objects

按tags过滤自动绑定的资源

最小长度:0

最大长度:5

表18 BindRulesTags

参数

参数类型

描述

key

String

key不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

key只能由中文,字母,数字,“-”,“_”组成。

value

String

value不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

value只能由中文,字母,数字,“-”,“_”,“.”组成。

请求示例

查询指定存储库。

GET https://{endpoint}/v3/{project_id}/vaults/{vault_id}

响应示例

状态码:200

OK

{
  "vault" : {
    "id" : "2b076f26-391f-40fa-bf71-a798940faccf",
    "name" : "sdk-vault1595581958",
    "resources" : [ ],
    "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
    "created_at" : "2020-07-24T09:12:49.492+00:00",
    "project_id" : "0605767b5780d5762fc5c0118072a564",
    "enterprise_project_id" : 0,
    "auto_bind" : true,
    "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" : 40
    },
    "tags" : [ {
      "key" : "fds"
    } ]
  }
}

状态码

状态码

描述

200

OK

404

Not Found

错误码

请参见错误码

相关文档