文档首页> 云备份 CBR> API参考（巴黎区域）> API> 存储库> 查询存储库列表
更新时间：2024-04-02 GMT+08:00
查看PDF

查询存储库列表

功能介绍

查询存储库列表

URI

GET /v3/{project_id}/vaults

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID
表2 Query参数

参数

是否必选

参数类型

描述

cloud_type

否

String

公有云: public

id

否

String

存储库ID

limit

否

Integer

每页显示条目数，正整数

最小值：1

最大值：1000

name

否

String

存储库名称

object_type

否

String

对象类型：云服务器（server），云硬盘（disk），文件系统（turbo）。

offset

否

Integer

偏移值,正整数

policy_id

否

String

策略ID

protect_type

否

String

保护类型：备份（backup）。

resource_ids

否

String

资源id，支持多资源，以英文逗号分割

status

否

String

状态

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

vaults

Array of Vault objects

存储库实例列表

count

Integer

存储库个数

limit

Integer

每页显示的条目数量

最小值：1

最大值：1000

缺省值：1000

offset

Integer

偏移量，表示从此偏移量开始查询

最小值：0

缺省值：0
表5 Vault

参数

参数类型

描述

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

存储库标签

auto_bind

Boolean

是否自动绑定，默认为false，不支持。

bind_rules

VaultBindRules object

绑定规则

user_id

String

用户id

created_at

String

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

auto_expand

Boolean

是否开启存储库自动扩容能力。

sys_lock_source_service

String

用于标识SMB服务，您可以设置为SMB或者空

最小长度：0

最大长度：32

枚举值：

  • SMB

  • ''
表6 Billing

参数

参数类型

描述

allocated

Integer

已分配容量，单位GB

charging_mode

String

创建模式，按需：post_paid

cloud_type

String

公有云: public

consistent_level

String

规格，默认为崩溃一致性（crash_consistent）

object_type

String

对象类型：云服务器（server），云硬盘（disk），文件系统（turbo）。

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

存储库状态

  • available: 可用

  • lock: 锁定

  • frozen: 冻结

  • deleting: 删除中

  • error: 异常

枚举值：

  • available

  • lock

  • frozen

  • deleting

  • error

storage_unit

String

存储库桶名

used

Integer

已使用容量，单位MB

frozen_scene

String

冻结场景
表7 ResourceResp

参数

参数类型

描述

id

String

待备份资源id

name

String

待备份资源名称

最小长度：0

最大长度：255

protect_status

String

保护状态

  • available: 可用

  • error: 异常

  • protecting: 保护中

  • restoring: 恢复中

  • removing: 删除中

枚举值：

  • available

  • error

  • protecting

  • restoring

  • removing

size

Integer

资源已分配容量,单位为GB

type

String

待备份资源的类型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Sfs::Turbo

backup_size

Integer

副本大小

backup_count

Integer

副本数量
表8 VaultBindRules

参数

参数类型

描述

tags

Array of BindRulesTags objects

按tags过滤自动绑定的资源

最小长度：0

最大长度：5

数组长度：0 - 5

请求示例

查询存储库列表。

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" : [ ]
  } ],
  "count" : 50
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 存储库