文档首页/ 云备份 CBR/ API参考/ API/ 存储库/ 查询其他区域存储库列表 - ListExternalVault
更新时间:2026-10-20 GMT+08:00
分享

查询其他区域存储库列表 - ListExternalVault

功能介绍

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

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v3/{project_id}/vaults/external

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,获取方法请参见获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

cloud_type

否

String

参数解释:

云类型

约束限制:

不涉及

取值范围:

public:公有云; hybrid: 混合云

默认取值:

public

external_project_id

是

String

参数解释:

其他区域的项目ID,获取方法请参见获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

limit

否

Integer

参数解释:

返回结果个数限制

约束限制:

不涉及

取值范围:

1-1000

默认取值:

不涉及

object_type

否

String

参数解释:

对象类型

约束限制:

不涉及

取值范围:

支持"server", "disk", "turbo", "workspace", "vmware", "rds"和"file"共七种。server:云服务器,disk:云硬盘,turbo:文件系统,workspace:云桌面,vmware:VMware,rds:关系型数据库,file:文件

默认取值:

不涉及

offset

否

Integer

参数解释:

偏移值

约束限制:

不涉及

取值范围:

[0,2147483647]

默认取值:

0

protect_type

否

String

参数解释:

保护类型

约束限制:

不涉及

取值范围:

backup:备份,replication:复制

默认取值:

不涉及

region_id

是

String

参数解释:

区域ID

获取方法请参见"地区和终端节点查询"。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

vault_id

否

String

参数解释:

存储库ID,获取方法请参见获取存储库ID

约束限制:

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

取值范围:

不涉及

默认取值:

不涉及

请求参数

无

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

vaults

Array of VaultResp objects

参数解释:

存储库实例列表,包括存储库的名称,规格等信息

取值范围:

不涉及

count

Integer

参数解释:

存储库个数

取值范围:

不涉及

limit

Integer

参数解释:

每页显示的条目数量

取值范围:

[1-1000]

offset

Integer

参数解释:

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

取值范围:

[0,2147483647]

表4 VaultResp

参数

参数类型

描述

billing

Billing object

参数解释:

运营信息,包括存储库名称,绑定的资源等信息

取值范围:

不涉及

description

String

参数解释:

存储库自定义描述信息

取值范围:

不能包含“<”,“>”,最大支持255个字符

id

String

参数解释:

存储库ID,获取方法可参考查询存储库列表

取值范围:

UUID,形式为32个十六进制数字

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 TagResp objects

参数解释:

存储库资源的标签,标签由键值对组成

取值范围:

不涉及

enterprise_project_id

String

参数解释:

云备份企业项目ID,获取方法可参考查询企业项目列表接口。

取值范围:

不涉及

auto_bind

Boolean

参数解释:

是否支持自动挂载

取值范围:

  • true:支持自动挂载

  • false:不支持自动挂载

bind_rules

VaultBindRulesResp object

参数解释:

绑定规则,用于配置存储库自动绑定功能的规则

取值范围:

不涉及

user_id

String

参数解释:

用户ID

取值范围:

不涉及

created_at

String

参数解释:

创建时间,格式为YYYY-MM-DDTHH:MM:SS.ffffff

取值范围:

不涉及

auto_expand

Boolean

参数解释:

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

取值范围:

true:支持自动扩容

false:不支持自动扩容

smn_notify

Boolean

参数解释:

使用smn发送通知的开关

取值范围:

  • true:发送smn通知

  • false:不发送smn通知

threshold

Integer

参数解释:

存储库容量阈值,存储库已用容量和总容量的百分比超过该值,如果smn_notify为开,将发送相关通知

取值范围:

1-100,代表已用容量占总容量的百分比

sys_lock_source_service

String

参数解释:

用于标识SMB服务,支持传入SMB和空

取值范围:

SMB:标识为SMB服务调用

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

locked

Boolean

参数解释:

用于标识当前存储库是否已锁定,关于备份锁定的详细信息,请参考开启备份锁定

取值范围:

  • true:锁定存储库

  • false:不锁定存储库

availability_zone

String

参数解释:

存储库可用区信息

取值范围:

长度1~32个字符

表5 Billing

参数

参数类型

描述

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

参数解释:

容量,单位MB

取值范围:

10-10485760

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

参数解释:

冻结场景,说明具体冻结原因

取值范围:

  • POLICE:公安冻结场景

  • ARREAR:欠费场景

  • ILLEGAL:违规冻结场景

  • VERIFY:客户未实名认证冻结场景

  • DELETE_ACCOUNT:退订删除场景

is_multi_az

Boolean

参数解释:

存储库是否具有多AZ属性,即底层备份是否为多AZ备份

取值范围:

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

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

表6 ResourceResp

参数

参数类型

描述

extra_info

ResourceExtraInfoResp 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 ResourceExtraInfoResp

参数

参数类型

描述

exclude_volumes

Array of strings

参数解释:

需要排除备份的卷ID列表,列表元素为String类型的UUID。

取值范围:

不涉及

表8 TagResp

参数

参数类型

描述

key

String

参数解释:

标签的键,用于标识和分类资源

取值范围:

key最大长度为36个字符且不能为空字符串,前后空格会被丢弃。

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

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

value

String

参数解释:

标签的值,用于描述存储库资源的具体属性

取值范围:

最大长度43字符且允许为空,前后空格会自动去除。此外,value不能包含非打印字符及= * < > \ , | /等特殊符号

表9 VaultBindRulesResp

参数

参数类型

描述

tags

Array of BindRulesTagsResp objects

参数解释:

按标签过滤自动绑定的资源

取值范围:

最小长度:0

最大长度:5

表10 BindRulesTagsResp

参数

参数类型

描述

key

String

参数解释:

标签的键,用于标识和分类存储库资源

取值范围:

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

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

value

String

参数解释:

标签的值,与键配合使用,用于更精确地标识和分类存储库资源

取值范围:

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

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

请求示例

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

响应示例

状态码:200

{
  "count": 1,
  "limit": 100,
  "offset": 1,
  "vaults": [
    {
      "provider_id": "0daac4c5-6707-4851-97ba-169e36266b66",
      "name": "vault-name",
      "billing": {
        "status": "available",
        "used": 5588,
        "protect_type": "backup",
        "object_type": "server",
        "consistent_level": "crash_consistent",
        "cloud_type": "public",
        "allocated": 20,
        "charging_mode": "post_paid",
        "spec_code": "vault.backup.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

错误码

请参见错误码。

相关文档