文档首页/ 云备份 CBR/ API参考/ API/ 存储库/ 查询其他区域存储库列表
更新时间：2024-12-12 GMT+08:00
编辑
查看PDF
分享

查询其他区域存储库列表

功能介绍

查询其他区域的存储库列表

URI

GET /v3/{project_id}/vaults/external

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID
表2 Query参数

参数

是否必选

参数类型

描述

cloud_type

否

String

云类型。取值为public和hybrid。

external_project_id

是

String

其他区域的项目ID

limit

否

Integer

每页显示条目数

objcet_type

否

String

资源类型

offset

否

Integer

偏移值

protect_type

否

String

保护类型。取值为backup，replication和hybrid。

region_id

是

String

区域ID

vault_id

否

String

存储库ID，指定存储ID时其他过滤条件不生效。

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

vaults

Array of Vault objects

存储库实例列表

count

Integer

存储库个数

limit

Integer

每页显示的条目数量

offset

Integer

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

参数

参数类型

描述

billing

Billing object

运营信息

description

String

存储库自定义描述信息。

id

String

存储库ID

name

String

存储库名称

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

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

smn_notify

Boolean

存储库smn消息通知开关

threshold

Integer

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

sys_lock_source_service

String

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

locked

Boolean

用于标识当前存储库是否已锁定，锁定的存储库不支持解锁。
表5 Billing

参数

参数类型

描述

allocated

Integer

已分配容量，单位GB

charging_mode

String

创建模式，按需：post_paid，包周期：pre_paid，默认为post_paid

cloud_type

String

公有云:public ;混合云:hybrid

consistent_level

String

规格，崩溃一致性（crash_consistent）或应用一致性（app_consistent）

object_type

String

对象类型：云服务器（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属性
表6 ResourceResp

参数

参数类型

描述

extra_info

ResourceExtraInfo object

资源附加信息

id

String

待备份资源id

name

String

待备份资源名称

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, OS::Workspace::DesktopV2

backup_size

Integer

副本大小

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

请求示例

GET /v3/{project_id}/vaults/external?external_project_id=68589cac08274b82b4e254268a3862d8&region_id=cn-shenzhen-1

响应示例

状态码： 200

OK

{
  "count" : 1,
  "vaults" : [ {
    "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
    "name" : "vault-name",
    "billing" : {
      "status" : "available",
      "used" : 5588,
      "protect_type" : "replication",
      "object_type" : "server",
      "consistent_level" : "crash_consistent",
      "cloud_type" : "public",
      "allocated" : 0,
      "charging_mode" : "post_paid",
      "spec_code" : "vault.replication.server.normal",
      "size" : 10
    },
    "tags" : [ ],
    "created_at" : "2019-04-08T11:06:25.766+00:00",
    "enterprise_project_id" : "876ae48d-cfb3-4aff-bb55-83167abd3876",
    "project_id" : "68589cac08274b82b4e254268a3862d8",
    "id" : "0ca3eb86-8800-46da-9c37-9d657a825274",
    "resources" : [ ]
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 存储库

相关文档