文档首页 > > API参考> API> 存储库> 查询存储库列表

查询存储库列表

分享
更新时间:2020/10/29 GMT+08:00

功能介绍

查询存储库列表

URI

GET /v3/{project_id}/vaults

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

表2 Query参数

参数

是否必选

参数类型

描述

cloud_type

String

云类型

枚举值:

  • public

  • hybrid

enterprise_project_id

String

企业项目id或all_granted_eps,all_granted_eps表示查询用户有权限的所有企业项目id

id

String

存储库ID

limit

Integer

每页显示条目数,正整数

最小值:1

最大值:1000

name

String

存储库名称

object_type

String

资源类型

offset

Integer

偏移值,正整数

policy_id

String

策略ID

protect_type

String

保护类型

枚举值:

  • backup

  • replication

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

存储库个数

表5 Vault

参数

参数类型

描述

billing

Billing object

运营信息

description

String

存储库自定义描述信息。

最小长度:0

最大长度:255

id

String

保管库ID

name

String

保管库名称

最小长度:1

最大长度:64

project_id

String

项目ID

provider_id

String

保管库类型

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

是否开启存储库自动扩容能力(只支持按需存储库)。

表6 Billing

参数

参数类型

描述

allocated

Integer

已分配容量,单位MB

charging_mode

String

创建模式

枚举值:

  • pre_paid

  • post_paid

cloud_type

String

云平台

枚举值:

  • public

  • hybrid

consistent_level

String

规格,崩溃一致性(crash_consistent)或应用一致性(app_consistent)

object_type

String

对象类型

枚举值:

  • server

  • disk

order_id

String

订单ID

product_id

String

产品ID

protect_type

String

保护类型

枚举值:

  • backup

  • replication

  • hybrid

size

Integer

容量,单位GB

最小值:1

最大值:10485760

spec_code

String

规格编码

枚举值:

  • vault.backup.server.normal

  • vault.backup.volume.normal

status

String

保管库状态

枚举值:

  • available

  • lock

  • frozen

  • deleting

  • error

storage_unit

String

存储库桶名

used

Integer

已使用容量,单位MB

frozen_scene

String

冻结场景

表7 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::Native::Server, OS::Sfs::Turbo

backup_size

Integer

副本大小

backup_count

Integer

副本数量

表8 ResourceExtraInfo

参数

参数类型

描述

exclude_volumes

Array of strings

需要排除备份的卷id。仅虚拟机磁盘级备份有效

include_volumes

Array of ResourceExtraInfoIncludeVolumes objects

要备份的卷

表9 ResourceExtraInfoIncludeVolumes

参数

参数类型

描述

id

String

卷ID,仅支持uuid

os_version

String

操作系统类型

表10 VaultBindRules

参数

参数类型

描述

tags

Array of Tag objects

按tags过滤自动绑定的资源

表11 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只能由中文,字母,数字,“-”,“_”,“.”组成。

请求示例

响应示例

状态码: 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.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",
      "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

错误码

请参见错误码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问