文档首页/ 云备份 CBR/ API参考/ API/ 存储库/ 查询指定存储库

更新时间：2024-06-20 GMT+08:00

在线调试

CLI示例

编辑

查看PDF

查询指定存储库

功能介绍

根据ID查询指定存储库

调用方法

请参见如何调用API。

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID
vault_id	是	String	存储库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	存储库自定义描述信息。最小长度：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	存储库标签
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消息通知开关缺省值：true
threshold	Integer	存储库容量阈值，已用容量占总容量达到此百分比即发送相关通知最小值：1 最大值：100 缺省值：80
sys_lock_source_service	String	用于标识SMB服务，您可以设置为SMB或者空最小长度：0 最大长度：32

表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 最小值：1 最大值：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	冻结场景
is_multi_az	Boolean	存储库多az属性缺省值：false

表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::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 数组长度：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	存储库自定义描述信息。最小长度：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	存储库标签
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消息通知开关缺省值：true
threshold	Integer	存储库容量阈值，已用容量占总容量达到此百分比即发送相关通知最小值：1 最大值：100 缺省值：80
sys_lock_source_service	String	用于标识SMB服务，您可以设置为SMB或者空最小长度：0 最大长度：32

**表13** 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 最小值：1 最大值：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	冻结场景
is_multi_az	Boolean	存储库多az属性缺省值：false

**表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::Native::Server, OS::Sfs::Turbo, OS::Workspace::DesktopV2
backup_size	Integer	副本大小
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 数组长度：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

{
  "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"
    } ]
  }
}

SDK代码示例

SDK代码示例如下。

Java

    
     
       
       
         package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.cbr.v1.region.CbrRegion;
import com.huaweicloud.sdk.cbr.v1.*;
import com.huaweicloud.sdk.cbr.v1.model.*;


public class ShowVaultSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        CbrClient client = CbrClient.newBuilder()
                .withCredential(auth)
                .withRegion(CbrRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowVaultRequest request = new ShowVaultRequest();
        try {
            ShowVaultResponse response = client.showVault(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

        

      

    
   

Python

    
     
       
       
         # coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcbr.v1.region.cbr_region import CbrRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcbr.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = CbrClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CbrRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowVaultRequest()
        response = client.show_vault(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

        

      

    
   

Go

    
     
       
       
         package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cbr "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cbr/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cbr/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cbr/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := cbr.NewCbrClient(
        cbr.CbrClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowVaultRequest{}
	response, err := client.ShowVault(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

        

      

    
   

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码	描述
200	OK
404	Not Found

错误码

请参见错误码。

父主题： 存储库

上一篇：创建存储库

下一篇：查询存储库列表

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

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

智能客服提问云社区提问